Figshare API

Articles

accountArticlePublish

Private Article Publish

- If the whole article is under embargo, it will not be published immediately, but when the embargo expires or is lifted. - When an article is published, a new public version will be generated. Any further updates to the article will affect the private article data. In order to make these changes publicly visible, an explicit publish operation is needed.


/account/articles/{article_id}/publish

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/publish"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            Location result = apiInstance.accountArticlePublish(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticlePublish");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.accountArticlePublish(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountArticlePublish: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            Location result = apiInstance.accountArticlePublish(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticlePublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Private Article Publish
[apiInstance accountArticlePublishWith:articleId
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountArticlePublish(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountArticlePublishExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Private Article Publish
                Location result = apiInstance.accountArticlePublish(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.accountArticlePublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->accountArticlePublish($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->accountArticlePublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->accountArticlePublish(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->accountArticlePublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Private Article Publish
    api_response = api_instance.account_article_publish(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->accountArticlePublish: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.accountArticlePublish(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses

Name Type Format Description
Location String link Location of project


accountArticleReport

Account Article Report

Return status on all reports generated for the account from the oauth credentials


/account/articles/export

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/export?group_id=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long groupId = 789; // Long | A group ID to filter by

        try {
            array[AccountReport] result = apiInstance.accountArticleReport(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleReport");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long groupId = new Long(); // Long | A group ID to filter by

try {
    final result = await api_instance.accountArticleReport(groupId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountArticleReport: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long groupId = 789; // Long | A group ID to filter by

        try {
            array[AccountReport] result = apiInstance.accountArticleReport(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *groupId = 789; // A group ID to filter by (optional) (default to null)

// Account Article Report
[apiInstance accountArticleReportWith:groupId
              completionHandler: ^(array[AccountReport] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var opts = {
  'groupId': 789 // {Long} A group ID to filter by
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountArticleReport(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountArticleReportExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var groupId = 789;  // Long | A group ID to filter by (optional)  (default to null)

            try {
                // Account Article Report
                array[AccountReport] result = apiInstance.accountArticleReport(groupId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.accountArticleReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$groupId = 789; // Long | A group ID to filter by

try {
    $result = $api_instance->accountArticleReport($groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->accountArticleReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $groupId = 789; # Long | A group ID to filter by

eval {
    my $result = $api_instance->accountArticleReport(groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->accountArticleReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
groupId = 789 # Long | A group ID to filter by (optional) (default to null)

try:
    # Account Article Report
    api_response = api_instance.account_article_report(groupId=groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->accountArticleReport: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let groupId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.accountArticleReport(groupId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
group_id
Long (int64)
A group ID to filter by

Responses


accountArticleReportGenerate

Initiate a new Report

Initiate a new Article Report for this Account. There is a limit of 1 report per day.


/account/articles/export

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/export"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();

        try {
            AccountReport result = apiInstance.accountArticleReportGenerate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleReportGenerate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.accountArticleReportGenerate();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountArticleReportGenerate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();

        try {
            AccountReport result = apiInstance.accountArticleReportGenerate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleReportGenerate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];

// Initiate a new Report
[apiInstance accountArticleReportGenerateWithCompletionHandler: 
              ^(AccountReport output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountArticleReportGenerate(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountArticleReportGenerateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();

            try {
                // Initiate a new Report
                AccountReport result = apiInstance.accountArticleReportGenerate();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.accountArticleReportGenerate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();

try {
    $result = $api_instance->accountArticleReportGenerate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->accountArticleReportGenerate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();

eval {
    my $result = $api_instance->accountArticleReportGenerate();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->accountArticleReportGenerate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()

try:
    # Initiate a new Report
    api_response = api_instance.account_article_report_generate()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->accountArticleReportGenerate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {

    let mut context = ArticlesApi::Context::default();
    let result = client.accountArticleReportGenerate(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


accountArticleUnpublish

Public Article Unpublish

Allows authorized users to unpublish an article.


/account/articles/{article_id}/unpublish

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/unpublish" \
 -d '{
  "reason" : "Unpublish article reason"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUnpublishData reason = ; // ArticleUnpublishData | 

        try {
            apiInstance.accountArticleUnpublish(articleId, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleUnpublish");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final ArticleUnpublishData reason = new ArticleUnpublishData(); // ArticleUnpublishData | 

try {
    final result = await api_instance.accountArticleUnpublish(articleId, reason);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountArticleUnpublish: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUnpublishData reason = ; // ArticleUnpublishData | 

        try {
            apiInstance.accountArticleUnpublish(articleId, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#accountArticleUnpublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
ArticleUnpublishData *reason = ; // 

// Public Article Unpublish
[apiInstance accountArticleUnpublishWith:articleId
    reason:reason
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var reason = ; // {ArticleUnpublishData} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.accountArticleUnpublish(articleId, reason, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountArticleUnpublishExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var reason = new ArticleUnpublishData(); // ArticleUnpublishData | 

            try {
                // Public Article Unpublish
                apiInstance.accountArticleUnpublish(articleId, reason);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.accountArticleUnpublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$reason = ; // ArticleUnpublishData | 

try {
    $api_instance->accountArticleUnpublish($articleId, $reason);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->accountArticleUnpublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $reason = WWW::OPenAPIClient::Object::ArticleUnpublishData->new(); # ArticleUnpublishData | 

eval {
    $api_instance->accountArticleUnpublish(articleId => $articleId, reason => $reason);
};
if ($@) {
    warn "Exception when calling ArticlesApi->accountArticleUnpublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
reason =  # ArticleUnpublishData | 

try:
    # Public Article Unpublish
    api_instance.account_article_unpublish(articleId, reason)
except ApiException as e:
    print("Exception when calling ArticlesApi->accountArticleUnpublish: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let reason = ; // ArticleUnpublishData

    let mut context = ArticlesApi::Context::default();
    let result = client.accountArticleUnpublish(articleId, reason, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
reason *

Article unpublish data

Responses


articleDetails

View article details

View an article


/articles/{article_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier

        try {
            ArticleComplete result = apiInstance.articleDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier

try {
    final result = await api_instance.articleDetails(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier

        try {
            ArticleComplete result = apiInstance.articleDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)

// View article details
[apiInstance articleDetailsWith:articleId
              completionHandler: ^(ArticleComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleDetails(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)

            try {
                // View article details
                ArticleComplete result = apiInstance.articleDetails(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier

try {
    $result = $api_instance->articleDetails($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier

eval {
    my $result = $api_instance->articleDetails(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)

try:
    # View article details
    api_response = api_instance.article_details(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleDetails(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required

Responses


articleFileDetails

Article file details

File by id


/articles/{article_id}/files/{file_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/files/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long fileId = 789; // Long | File Unique identifier

        try {
            PublicFile result = apiInstance.articleFileDetails(articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleFileDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long fileId = new Long(); // Long | File Unique identifier

try {
    final result = await api_instance.articleFileDetails(articleId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleFileDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long fileId = 789; // Long | File Unique identifier

        try {
            PublicFile result = apiInstance.articleFileDetails(articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleFileDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *fileId = 789; // File Unique identifier (default to null)

// Article file details
[apiInstance articleFileDetailsWith:articleId
    fileId:fileId
              completionHandler: ^(PublicFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var fileId = 789; // {Long} File Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleFileDetails(articleId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleFileDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var fileId = 789;  // Long | File Unique identifier (default to null)

            try {
                // Article file details
                PublicFile result = apiInstance.articleFileDetails(articleId, fileId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleFileDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$fileId = 789; // Long | File Unique identifier

try {
    $result = $api_instance->articleFileDetails($articleId, $fileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleFileDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $fileId = 789; # Long | File Unique identifier

eval {
    my $result = $api_instance->articleFileDetails(articleId => $articleId, fileId => $fileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleFileDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
fileId = 789 # Long | File Unique identifier (default to null)

try:
    # Article file details
    api_response = api_instance.article_file_details(articleId, fileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleFileDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let fileId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleFileDetails(articleId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
file_id*
Long (int64)
File Unique identifier
Required

Responses


articleFiles

List article files

Files list for article


/articles/{article_id}/files

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/files?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PublicFile] result = apiInstance.articleFiles(articleId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleFiles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.articleFiles(articleId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleFiles: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PublicFile] result = apiInstance.articleFiles(articleId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// List article files
[apiInstance articleFilesWith:articleId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[PublicFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleFiles(articleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleFilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // List article files
                array[PublicFile] result = apiInstance.articleFiles(articleId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->articleFiles($articleId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->articleFiles(articleId => $articleId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # List article files
    api_response = api_instance.article_files(articleId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleFiles: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleFiles(articleId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


articleVersionConfidentiality

Public Article Confidentiality for article version

Confidentiality for article version. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.


/articles/{article_id}/versions/{version_id}/confidentiality

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/versions/{version_id}/confidentiality"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            ArticleConfidentiality result = apiInstance.articleVersionConfidentiality(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionConfidentiality");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long versionId = new Long(); // Long | Version Number

try {
    final result = await api_instance.articleVersionConfidentiality(articleId, versionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionConfidentiality: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            ArticleConfidentiality result = apiInstance.articleVersionConfidentiality(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionConfidentiality");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *versionId = 789; // Version Number (default to null)

// Public Article Confidentiality for article version
[apiInstance articleVersionConfidentialityWith:articleId
    versionId:versionId
              completionHandler: ^(ArticleConfidentiality output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var versionId = 789; // {Long} Version Number

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionConfidentiality(articleId, versionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionConfidentialityExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var versionId = 789;  // Long | Version Number (default to null)

            try {
                // Public Article Confidentiality for article version
                ArticleConfidentiality result = apiInstance.articleVersionConfidentiality(articleId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionConfidentiality: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$versionId = 789; // Long | Version Number

try {
    $result = $api_instance->articleVersionConfidentiality($articleId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionConfidentiality: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $versionId = 789; # Long | Version Number

eval {
    my $result = $api_instance->articleVersionConfidentiality(articleId => $articleId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionConfidentiality: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
versionId = 789 # Long | Version Number (default to null)

try:
    # Public Article Confidentiality for article version
    api_response = api_instance.article_version_confidentiality(articleId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionConfidentiality: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionConfidentiality(articleId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
version_id*
Long (int64)
Version Number
Required

Responses


articleVersionDetails

Article details for version

Article with specified version


/articles/{article_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/versions/{version_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Article Version Number

        try {
            ArticleComplete result = apiInstance.articleVersionDetails(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long versionId = new Long(); // Long | Article Version Number

try {
    final result = await api_instance.articleVersionDetails(articleId, versionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Article Version Number

        try {
            ArticleComplete result = apiInstance.articleVersionDetails(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *versionId = 789; // Article Version Number (default to null)

// Article details for version
[apiInstance articleVersionDetailsWith:articleId
    versionId:versionId
              completionHandler: ^(ArticleComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var versionId = 789; // {Long} Article Version Number

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionDetails(articleId, versionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var versionId = 789;  // Long | Article Version Number (default to null)

            try {
                // Article details for version
                ArticleComplete result = apiInstance.articleVersionDetails(articleId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$versionId = 789; // Long | Article Version Number

try {
    $result = $api_instance->articleVersionDetails($articleId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $versionId = 789; # Long | Article Version Number

eval {
    my $result = $api_instance->articleVersionDetails(articleId => $articleId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
versionId = 789 # Long | Article Version Number (default to null)

try:
    # Article details for version
    api_response = api_instance.article_version_details(articleId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionDetails(articleId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
version_id*
Long (int64)
Article Version Number
Required

Responses


articleVersionEmbargo

Public Article Embargo for article version

Embargo for article version


/articles/{article_id}/versions/{version_id}/embargo

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/versions/{version_id}/embargo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            ArticleEmbargo result = apiInstance.articleVersionEmbargo(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionEmbargo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long versionId = new Long(); // Long | Version Number

try {
    final result = await api_instance.articleVersionEmbargo(articleId, versionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionEmbargo: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            ArticleEmbargo result = apiInstance.articleVersionEmbargo(articleId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionEmbargo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *versionId = 789; // Version Number (default to null)

// Public Article Embargo for article version
[apiInstance articleVersionEmbargoWith:articleId
    versionId:versionId
              completionHandler: ^(ArticleEmbargo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var versionId = 789; // {Long} Version Number

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionEmbargo(articleId, versionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionEmbargoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var versionId = 789;  // Long | Version Number (default to null)

            try {
                // Public Article Embargo for article version
                ArticleEmbargo result = apiInstance.articleVersionEmbargo(articleId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionEmbargo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$versionId = 789; // Long | Version Number

try {
    $result = $api_instance->articleVersionEmbargo($articleId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionEmbargo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $versionId = 789; # Long | Version Number

eval {
    my $result = $api_instance->articleVersionEmbargo(articleId => $articleId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionEmbargo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
versionId = 789 # Long | Version Number (default to null)

try:
    # Public Article Embargo for article version
    api_response = api_instance.article_version_embargo(articleId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionEmbargo: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionEmbargo(articleId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
version_id*
Long (int64)
Version Number
Required

Responses


articleVersionFiles

Public Article version files

Article version file details


/articles/{article_id}/versions/{version_id}/files

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/versions/{version_id}/files?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Article Version Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PublicFile] result = apiInstance.articleVersionFiles(articleId, versionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionFiles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier
final Long versionId = new Long(); // Long | Article Version Unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.articleVersionFiles(articleId, versionId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionFiles: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier
        Long versionId = 789; // Long | Article Version Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PublicFile] result = apiInstance.articleVersionFiles(articleId, versionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionFiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)
Long *versionId = 789; // Article Version Unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Public Article version files
[apiInstance articleVersionFilesWith:articleId
    versionId:versionId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[PublicFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier
var versionId = 789; // {Long} Article Version Unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionFiles(articleId, versionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionFilesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)
            var versionId = 789;  // Long | Article Version Unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Public Article version files
                array[PublicFile] result = apiInstance.articleVersionFiles(articleId, versionId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier
$versionId = 789; // Long | Article Version Unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->articleVersionFiles($articleId, $versionId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier
my $versionId = 789; # Long | Article Version Unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->articleVersionFiles(articleId => $articleId, versionId => $versionId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)
versionId = 789 # Long | Article Version Unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Public Article version files
    api_response = api_instance.article_version_files(articleId, versionId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionFiles: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionFiles(articleId, versionId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required
version_id*
Long (int64)
Article Version Unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


articleVersionPartialUpdate

Partially update article version

Partially updating an article version by passing only the fields to change.


/account/articles/{article_id}/versions/{version_id}

Usage and SDK Samples

curl -X PATCH \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/versions/{version_id}" \
 -d '{
  "supplementary_fields" : [ {
    "name" : "abc",
    "value" : "def"
  }, {
    "name" : "fname",
    "value" : "fvalue"
  } ],
  "internal_metadata" : {
    "curation_review_date" : "2021-11-16T13:03:38",
    "export_pdf_download_url" : null
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        ArticleVersionUpdate article = ; // ArticleVersionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.articleVersionPartialUpdate(articleId, versionId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionPartialUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long versionId = new Long(); // Long | Article version identifier
final ArticleVersionUpdate article = new ArticleVersionUpdate(); // ArticleVersionUpdate | 

try {
    final result = await api_instance.articleVersionPartialUpdate(articleId, versionId, article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionPartialUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        ArticleVersionUpdate article = ; // ArticleVersionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.articleVersionPartialUpdate(articleId, versionId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *versionId = 789; // Article version identifier (default to null)
ArticleVersionUpdate *article = ; // 

// Partially update article version
[apiInstance articleVersionPartialUpdateWith:articleId
    versionId:versionId
    article:article
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var versionId = 789; // {Long} Article version identifier
var article = ; // {ArticleVersionUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionPartialUpdate(articleId, versionId, article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionPartialUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var versionId = 789;  // Long | Article version identifier (default to null)
            var article = new ArticleVersionUpdate(); // ArticleVersionUpdate | 

            try {
                // Partially update article version
                LocationWarningsUpdate result = apiInstance.articleVersionPartialUpdate(articleId, versionId, article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$versionId = 789; // Long | Article version identifier
$article = ; // ArticleVersionUpdate | 

try {
    $result = $api_instance->articleVersionPartialUpdate($articleId, $versionId, $article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $versionId = 789; # Long | Article version identifier
my $article = WWW::OPenAPIClient::Object::ArticleVersionUpdate->new(); # ArticleVersionUpdate | 

eval {
    my $result = $api_instance->articleVersionPartialUpdate(articleId => $articleId, versionId => $versionId, article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionPartialUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
versionId = 789 # Long | Article version identifier (default to null)
article =  # ArticleVersionUpdate | 

try:
    # Partially update article version
    api_response = api_instance.article_version_partial_update(articleId, versionId, article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionPartialUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long
    let article = ; // ArticleVersionUpdate

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionPartialUpdate(articleId, versionId, article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
version_id*
Long (int64)
Article version identifier
Required
Body parameters
Name Description
article *

Subset of article version fields to update

Responses

Name Type Format Description
Location String link Location of project


articleVersionUpdate

Update article version

Updating an article version by passing body parameters.


/account/articles/{article_id}/versions/{version_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/versions/{version_id}" \
 -d '{
  "supplementary_fields" : [ {
    "name" : "abc",
    "value" : "def"
  }, {
    "name" : "fname",
    "value" : "fvalue"
  } ],
  "internal_metadata" : {
    "curation_review_date" : "2021-11-16T13:03:38",
    "export_pdf_download_url" : null
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        ArticleVersionUpdate article = ; // ArticleVersionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.articleVersionUpdate(articleId, versionId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long versionId = new Long(); // Long | Article version identifier
final ArticleVersionUpdate article = new ArticleVersionUpdate(); // ArticleVersionUpdate | 

try {
    final result = await api_instance.articleVersionUpdate(articleId, versionId, article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        ArticleVersionUpdate article = ; // ArticleVersionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.articleVersionUpdate(articleId, versionId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *versionId = 789; // Article version identifier (default to null)
ArticleVersionUpdate *article = ; // 

// Update article version
[apiInstance articleVersionUpdateWith:articleId
    versionId:versionId
    article:article
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var versionId = 789; // {Long} Article version identifier
var article = ; // {ArticleVersionUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersionUpdate(articleId, versionId, article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var versionId = 789;  // Long | Article version identifier (default to null)
            var article = new ArticleVersionUpdate(); // ArticleVersionUpdate | 

            try {
                // Update article version
                LocationWarningsUpdate result = apiInstance.articleVersionUpdate(articleId, versionId, article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$versionId = 789; // Long | Article version identifier
$article = ; // ArticleVersionUpdate | 

try {
    $result = $api_instance->articleVersionUpdate($articleId, $versionId, $article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $versionId = 789; # Long | Article version identifier
my $article = WWW::OPenAPIClient::Object::ArticleVersionUpdate->new(); # ArticleVersionUpdate | 

eval {
    my $result = $api_instance->articleVersionUpdate(articleId => $articleId, versionId => $versionId, article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
versionId = 789 # Long | Article version identifier (default to null)
article =  # ArticleVersionUpdate | 

try:
    # Update article version
    api_response = api_instance.article_version_update(articleId, versionId, article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long
    let article = ; // ArticleVersionUpdate

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionUpdate(articleId, versionId, article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
version_id*
Long (int64)
Article version identifier
Required
Body parameters
Name Description
article *

Article description

Responses

Name Type Format Description
Location String link Location of project


articleVersionUpdateThumb

Update article version thumbnail

For a given public article version update the article thumbnail by choosing one of the associated files


/account/articles/{article_id}/versions/{version_id}/update_thumb

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/versions/{version_id}/update_thumb" \
 -d '{
  "file_id" : 123
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        FileId fileId = ; // FileId | 

        try {
            apiInstance.articleVersionUpdateThumb(articleId, versionId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionUpdateThumb");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long versionId = new Long(); // Long | Article version identifier
final FileId fileId = new FileId(); // FileId | 

try {
    final result = await api_instance.articleVersionUpdateThumb(articleId, versionId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersionUpdateThumb: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Article version identifier
        FileId fileId = ; // FileId | 

        try {
            apiInstance.articleVersionUpdateThumb(articleId, versionId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersionUpdateThumb");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *versionId = 789; // Article version identifier (default to null)
FileId *fileId = ; // 

// Update article version thumbnail
[apiInstance articleVersionUpdateThumbWith:articleId
    versionId:versionId
    fileId:fileId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var versionId = 789; // {Long} Article version identifier
var fileId = ; // {FileId} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.articleVersionUpdateThumb(articleId, versionId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionUpdateThumbExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var versionId = 789;  // Long | Article version identifier (default to null)
            var fileId = new FileId(); // FileId | 

            try {
                // Update article version thumbnail
                apiInstance.articleVersionUpdateThumb(articleId, versionId, fileId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersionUpdateThumb: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$versionId = 789; // Long | Article version identifier
$fileId = ; // FileId | 

try {
    $api_instance->articleVersionUpdateThumb($articleId, $versionId, $fileId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersionUpdateThumb: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $versionId = 789; # Long | Article version identifier
my $fileId = WWW::OPenAPIClient::Object::FileId->new(); # FileId | 

eval {
    $api_instance->articleVersionUpdateThumb(articleId => $articleId, versionId => $versionId, fileId => $fileId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersionUpdateThumb: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
versionId = 789 # Long | Article version identifier (default to null)
fileId =  # FileId | 

try:
    # Update article version thumbnail
    api_instance.article_version_update_thumb(articleId, versionId, fileId)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersionUpdateThumb: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long
    let fileId = ; // FileId

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersionUpdateThumb(articleId, versionId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
version_id*
Long (int64)
Article version identifier
Required
Body parameters
Name Description
fileId *

File ID

Responses

Name Type Format Description
Location String link Location of project


articleVersions

List article versions

List public article versions


/articles/{article_id}/versions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles/{article_id}/versions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier

        try {
            array[ArticleVersions] result = apiInstance.articleVersions(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article Unique identifier

try {
    final result = await api_instance.articleVersions(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articleVersions: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article Unique identifier

        try {
            array[ArticleVersions] result = apiInstance.articleVersions(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articleVersions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article Unique identifier (default to null)

// List article versions
[apiInstance articleVersionsWith:articleId
              completionHandler: ^(array[ArticleVersions] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleVersions(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articleVersionsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article Unique identifier (default to null)

            try {
                // List article versions
                array[ArticleVersions] result = apiInstance.articleVersions(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articleVersions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article Unique identifier

try {
    $result = $api_instance->articleVersions($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articleVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article Unique identifier

eval {
    my $result = $api_instance->articleVersions(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articleVersions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article Unique identifier (default to null)

try:
    # List article versions
    api_response = api_instance.article_versions(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articleVersions: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.articleVersions(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article Unique identifier
Required

Responses


articlesList

Public Articles

Returns a list of public articles


/articles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/articles?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example&institution=789&published_since=publishedSince_example&modified_since=modifiedSince_example&group=789&resource_doi=resourceDoi_example&item_type=789&doi=doi_example&handle=handle_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return articles from this institution
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        String modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        Long group = 789; // Long | only return articles from this group
        String resourceDoi = resourceDoi_example; // String | Deprecated by related materials. Only return articles with this resource_doi
        Long itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
        String doi = doi_example; // String | only return articles with this doi
        String handle = handle_example; // String | only return articles with this handle

        try {
            array[Article] result = apiInstance.articlesList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, itemType, doi, handle);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articlesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order. Default varies by endpoint/resource.
final String orderDirection = new String(); // String | 
final Long institution = new Long(); // Long | only return articles from this institution
final String publishedSince = new String(); // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
final String modifiedSince = new String(); // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
final Long group = new Long(); // Long | only return articles from this group
final String resourceDoi = new String(); // String | Deprecated by related materials. Only return articles with this resource_doi
final Long itemType = new Long(); // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
final String doi = new String(); // String | only return articles with this doi
final String handle = new String(); // String | only return articles with this handle

try {
    final result = await api_instance.articlesList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, itemType, doi, handle);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articlesList: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return articles from this institution
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        String modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        Long group = 789; // Long | only return articles from this group
        String resourceDoi = resourceDoi_example; // String | Deprecated by related materials. Only return articles with this resource_doi
        Long itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
        String doi = doi_example; // String | only return articles with this doi
        String handle = handle_example; // String | only return articles with this handle

        try {
            array[Article] result = apiInstance.articlesList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, itemType, doi, handle);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articlesList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)
Long *institution = 789; // only return articles from this institution (optional) (default to null)
String *publishedSince = publishedSince_example; // Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
String *modifiedSince = modifiedSince_example; // Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
Long *group = 789; // only return articles from this group (optional) (default to null)
String *resourceDoi = resourceDoi_example; // Deprecated by related materials. Only return articles with this resource_doi (optional) (default to null)
Long *itemType = 789; // Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional) (default to null)
String *doi = doi_example; // only return articles with this doi (optional) (default to null)
String *handle = handle_example; // only return articles with this handle (optional) (default to null)

// Public Articles
[apiInstance articlesListWith:xCursor
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
    institution:institution
    publishedSince:publishedSince
    modifiedSince:modifiedSince
    group:group
    resourceDoi:resourceDoi
    itemType:itemType
    doi:doi
    handle:handle
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order. Default varies by endpoint/resource.
  'orderDirection': orderDirection_example, // {String} 
  'institution': 789, // {Long} only return articles from this institution
  'publishedSince': publishedSince_example, // {String} Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
  'modifiedSince': modifiedSince_example, // {String} Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
  'group': 789, // {Long} only return articles from this group
  'resourceDoi': resourceDoi_example, // {String} Deprecated by related materials. Only return articles with this resource_doi
  'itemType': 789, // {Long} Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
  'doi': doi_example, // {String} only return articles with this doi
  'handle': handle_example // {String} only return articles with this handle
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articlesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articlesListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. Default varies by endpoint/resource. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)
            var institution = 789;  // Long | only return articles from this institution (optional)  (default to null)
            var publishedSince = publishedSince_example;  // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional)  (default to null)
            var modifiedSince = modifiedSince_example;  // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional)  (default to null)
            var group = 789;  // Long | only return articles from this group (optional)  (default to null)
            var resourceDoi = resourceDoi_example;  // String | Deprecated by related materials. Only return articles with this resource_doi (optional)  (default to null)
            var itemType = 789;  // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional)  (default to null)
            var doi = doi_example;  // String | only return articles with this doi (optional)  (default to null)
            var handle = handle_example;  // String | only return articles with this handle (optional)  (default to null)

            try {
                // Public Articles
                array[Article] result = apiInstance.articlesList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, itemType, doi, handle);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articlesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
$orderDirection = orderDirection_example; // String | 
$institution = 789; // Long | only return articles from this institution
$publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
$modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
$group = 789; // Long | only return articles from this group
$resourceDoi = resourceDoi_example; // String | Deprecated by related materials. Only return articles with this resource_doi
$itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
$doi = doi_example; // String | only return articles with this doi
$handle = handle_example; // String | only return articles with this handle

try {
    $result = $api_instance->articlesList($xCursor, $page, $pageSize, $limit, $offset, $order, $orderDirection, $institution, $publishedSince, $modifiedSince, $group, $resourceDoi, $itemType, $doi, $handle);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articlesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order. Default varies by endpoint/resource.
my $orderDirection = orderDirection_example; # String | 
my $institution = 789; # Long | only return articles from this institution
my $publishedSince = publishedSince_example; # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
my $modifiedSince = modifiedSince_example; # String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
my $group = 789; # Long | only return articles from this group
my $resourceDoi = resourceDoi_example; # String | Deprecated by related materials. Only return articles with this resource_doi
my $itemType = 789; # Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
my $doi = doi_example; # String | only return articles with this doi
my $handle = handle_example; # String | only return articles with this handle

eval {
    my $result = $api_instance->articlesList(xCursor => $xCursor, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection, institution => $institution, publishedSince => $publishedSince, modifiedSince => $modifiedSince, group => $group, resourceDoi => $resourceDoi, itemType => $itemType, doi => $doi, handle => $handle);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articlesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)
institution = 789 # Long | only return articles from this institution (optional) (default to null)
publishedSince = publishedSince_example # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
modifiedSince = modifiedSince_example # String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
group = 789 # Long | only return articles from this group (optional) (default to null)
resourceDoi = resourceDoi_example # String | Deprecated by related materials. Only return articles with this resource_doi (optional) (default to null)
itemType = 789 # Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional) (default to null)
doi = doi_example # String | only return articles with this doi (optional) (default to null)
handle = handle_example # String | only return articles with this handle (optional) (default to null)

try:
    # Public Articles
    api_response = api_instance.articles_list(xCursor=xCursor, page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection, institution=institution, publishedSince=publishedSince, modifiedSince=modifiedSince, group=group, resourceDoi=resourceDoi, itemType=itemType, doi=doi, handle=handle)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articlesList: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String
    let institution = 789; // Long
    let publishedSince = publishedSince_example; // String
    let modifiedSince = modifiedSince_example; // String
    let group = 789; // Long
    let resourceDoi = resourceDoi_example; // String
    let itemType = 789; // Long
    let doi = doi_example; // String
    let handle = handle_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.articlesList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, itemType, doi, handle, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order. Default varies by endpoint/resource.
order_direction
String
institution
Long (int64)
only return articles from this institution
published_since
String
Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
modified_since
String
Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
group
Long (int64)
only return articles from this group
resource_doi
String
Deprecated by related materials. Only return articles with this resource_doi
item_type
Long (int64)
Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
doi
String
only return articles with this doi
handle
String
only return articles with this handle

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.


articlesSearch

Public Articles Search

Returns a list of public articles, filtered by the search parameters


/articles/search

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/articles/search" \
 -d '{
  "project_id" : 1,
  "resource_doi" : "10.6084/m9.figshare.1407024",
  "item_type" : 1,
  "handle" : "111084/m9.figshare.14074",
  "doi" : "10.6084/m9.figshare.1407024",
  "order" : "published_date"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        ArticleSearch search = ; // ArticleSearch | 

        try {
            array[ArticleWithProject] result = apiInstance.articlesSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articlesSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final ArticleSearch search = new ArticleSearch(); // ArticleSearch | 

try {
    final result = await api_instance.articlesSearch(xCursor, search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->articlesSearch: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        ArticleSearch search = ; // ArticleSearch | 

        try {
            array[ArticleWithProject] result = apiInstance.articlesSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#articlesSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
ArticleSearch *search = ; //  (optional)

// Public Articles Search
[apiInstance articlesSearchWith:xCursor
    search:search
              completionHandler: ^(array[ArticleWithProject] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'search':  // {ArticleSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articlesSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class articlesSearchExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var search = new ArticleSearch(); // ArticleSearch |  (optional) 

            try {
                // Public Articles Search
                array[ArticleWithProject] result = apiInstance.articlesSearch(xCursor, search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.articlesSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$search = ; // ArticleSearch | 

try {
    $result = $api_instance->articlesSearch($xCursor, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->articlesSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $search = WWW::OPenAPIClient::Object::ArticleSearch->new(); # ArticleSearch | 

eval {
    my $result = $api_instance->articlesSearch(xCursor => $xCursor, search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->articlesSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
search =  # ArticleSearch |  (optional)

try:
    # Public Articles Search
    api_response = api_instance.articles_search(xCursor=xCursor, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->articlesSearch: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let search = ; // ArticleSearch

    let mut context = ArticlesApi::Context::default();
    let result = client.articlesSearch(xCursor, search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Body parameters
Name Description
search

Search Parameters

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.


privateArticleAuthorDelete

Delete article author

De-associate author from article


/account/articles/{article_id}/authors/{author_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/authors/{author_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long authorId = 789; // Long | Article Author unique identifier

        try {
            apiInstance.privateArticleAuthorDelete(articleId, authorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long authorId = new Long(); // Long | Article Author unique identifier

try {
    final result = await api_instance.privateArticleAuthorDelete(articleId, authorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleAuthorDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long authorId = 789; // Long | Article Author unique identifier

        try {
            apiInstance.privateArticleAuthorDelete(articleId, authorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *authorId = 789; // Article Author unique identifier (default to null)

// Delete article author
[apiInstance privateArticleAuthorDeleteWith:articleId
    authorId:authorId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var authorId = 789; // {Long} Article Author unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleAuthorDelete(articleId, authorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleAuthorDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var authorId = 789;  // Long | Article Author unique identifier (default to null)

            try {
                // Delete article author
                apiInstance.privateArticleAuthorDelete(articleId, authorId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleAuthorDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$authorId = 789; // Long | Article Author unique identifier

try {
    $api_instance->privateArticleAuthorDelete($articleId, $authorId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleAuthorDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $authorId = 789; # Long | Article Author unique identifier

eval {
    $api_instance->privateArticleAuthorDelete(articleId => $articleId, authorId => $authorId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleAuthorDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
authorId = 789 # Long | Article Author unique identifier (default to null)

try:
    # Delete article author
    api_instance.private_article_author_delete(articleId, authorId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleAuthorDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let authorId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleAuthorDelete(articleId, authorId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
author_id*
Long (int64)
Article Author unique identifier
Required

Responses


privateArticleAuthorsAdd

Add article authors

Associate new authors with the article. This will add new authors to the list of already associated authors


/account/articles/{article_id}/authors

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/authors" \
 -d '{
  "authors" : [ {
    "id" : 12121
  }, {
    "id" : 34345
  }, {
    "name" : "John Doe"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateArticleAuthorsAdd(articleId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsAdd");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final AuthorsCreator authors = new AuthorsCreator(); // AuthorsCreator | 

try {
    final result = await api_instance.privateArticleAuthorsAdd(articleId, authors);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleAuthorsAdd: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateArticleAuthorsAdd(articleId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsAdd");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
AuthorsCreator *authors = ; // 

// Add article authors
[apiInstance privateArticleAuthorsAddWith:articleId
    authors:authors
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var authors = ; // {AuthorsCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleAuthorsAdd(articleId, authors, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleAuthorsAddExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var authors = new AuthorsCreator(); // AuthorsCreator | 

            try {
                // Add article authors
                apiInstance.privateArticleAuthorsAdd(articleId, authors);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleAuthorsAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$authors = ; // AuthorsCreator | 

try {
    $api_instance->privateArticleAuthorsAdd($articleId, $authors);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleAuthorsAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $authors = WWW::OPenAPIClient::Object::AuthorsCreator->new(); # AuthorsCreator | 

eval {
    $api_instance->privateArticleAuthorsAdd(articleId => $articleId, authors => $authors);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleAuthorsAdd: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
authors =  # AuthorsCreator | 

try:
    # Add article authors
    api_instance.private_article_authors_add(articleId, authors)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleAuthorsAdd: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let authors = ; // AuthorsCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleAuthorsAdd(articleId, authors, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
authors *

Authors description

Responses

Name Type Format Description
Location String url Location of article


privateArticleAuthorsList

List article authors

List article authors


/account/articles/{article_id}/authors

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/authors"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            array[Author] result = apiInstance.privateArticleAuthorsList(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleAuthorsList(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleAuthorsList: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            array[Author] result = apiInstance.privateArticleAuthorsList(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// List article authors
[apiInstance privateArticleAuthorsListWith:articleId
              completionHandler: ^(array[Author] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleAuthorsList(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleAuthorsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // List article authors
                array[Author] result = apiInstance.privateArticleAuthorsList(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleAuthorsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleAuthorsList($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleAuthorsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleAuthorsList(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleAuthorsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # List article authors
    api_response = api_instance.private_article_authors_list(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleAuthorsList: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleAuthorsList(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleAuthorsReplace

Replace article authors

Associate new authors with the article. This will remove all already associated authors and add these new ones


/account/articles/{article_id}/authors

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/authors" \
 -d '{
  "authors" : [ {
    "id" : 12121
  }, {
    "id" : 34345
  }, {
    "name" : "John Doe"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateArticleAuthorsReplace(articleId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final AuthorsCreator authors = new AuthorsCreator(); // AuthorsCreator | 

try {
    final result = await api_instance.privateArticleAuthorsReplace(articleId, authors);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleAuthorsReplace: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateArticleAuthorsReplace(articleId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleAuthorsReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
AuthorsCreator *authors = ; // 

// Replace article authors
[apiInstance privateArticleAuthorsReplaceWith:articleId
    authors:authors
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var authors = ; // {AuthorsCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleAuthorsReplace(articleId, authors, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleAuthorsReplaceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var authors = new AuthorsCreator(); // AuthorsCreator | 

            try {
                // Replace article authors
                apiInstance.privateArticleAuthorsReplace(articleId, authors);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleAuthorsReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$authors = ; // AuthorsCreator | 

try {
    $api_instance->privateArticleAuthorsReplace($articleId, $authors);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleAuthorsReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $authors = WWW::OPenAPIClient::Object::AuthorsCreator->new(); # AuthorsCreator | 

eval {
    $api_instance->privateArticleAuthorsReplace(articleId => $articleId, authors => $authors);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleAuthorsReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
authors =  # AuthorsCreator | 

try:
    # Replace article authors
    api_instance.private_article_authors_replace(articleId, authors)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleAuthorsReplace: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let authors = ; // AuthorsCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleAuthorsReplace(articleId, authors, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
authors *

Authors description

Responses

Name Type Format Description
Location String url Location of article


privateArticleCategoriesAdd

Add article categories

Associate new categories with the article. This will add new categories to the list of already associated categories


/account/articles/{article_id}/categories

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/categories" \
 -d '{
  "categories" : [ 1, 10, 11 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateArticleCategoriesAdd(articleId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesAdd");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final CategoriesCreator categories = new CategoriesCreator(); // CategoriesCreator | 

try {
    final result = await api_instance.privateArticleCategoriesAdd(articleId, categories);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleCategoriesAdd: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateArticleCategoriesAdd(articleId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesAdd");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
CategoriesCreator *categories = ; // 

// Add article categories
[apiInstance privateArticleCategoriesAddWith:articleId
    categories:categories
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var categories = ; // {CategoriesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleCategoriesAdd(articleId, categories, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleCategoriesAddExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var categories = new CategoriesCreator(); // CategoriesCreator | 

            try {
                // Add article categories
                apiInstance.privateArticleCategoriesAdd(articleId, categories);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleCategoriesAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$categories = ; // CategoriesCreator | 

try {
    $api_instance->privateArticleCategoriesAdd($articleId, $categories);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleCategoriesAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $categories = WWW::OPenAPIClient::Object::CategoriesCreator->new(); # CategoriesCreator | 

eval {
    $api_instance->privateArticleCategoriesAdd(articleId => $articleId, categories => $categories);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleCategoriesAdd: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
categories =  # CategoriesCreator | 

try:
    # Add article categories
    api_instance.private_article_categories_add(articleId, categories)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleCategoriesAdd: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let categories = ; // CategoriesCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleCategoriesAdd(articleId, categories, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
categories *

Responses


privateArticleCategoriesList

List article categories

List article categories


/account/articles/{article_id}/categories

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/categories"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            array[Category] result = apiInstance.privateArticleCategoriesList(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleCategoriesList(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleCategoriesList: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            array[Category] result = apiInstance.privateArticleCategoriesList(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// List article categories
[apiInstance privateArticleCategoriesListWith:articleId
              completionHandler: ^(array[Category] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleCategoriesList(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleCategoriesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // List article categories
                array[Category] result = apiInstance.privateArticleCategoriesList(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleCategoriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleCategoriesList($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleCategoriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleCategoriesList(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleCategoriesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # List article categories
    api_response = api_instance.private_article_categories_list(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleCategoriesList: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleCategoriesList(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleCategoriesReplace

Replace article categories

Associate new categories with the article. This will remove all already associated categories and add these new ones


/account/articles/{article_id}/categories

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/categories" \
 -d '{
  "categories" : [ 1, 10, 11 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateArticleCategoriesReplace(articleId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final CategoriesCreator categories = new CategoriesCreator(); // CategoriesCreator | 

try {
    final result = await api_instance.privateArticleCategoriesReplace(articleId, categories);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleCategoriesReplace: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateArticleCategoriesReplace(articleId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoriesReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
CategoriesCreator *categories = ; // 

// Replace article categories
[apiInstance privateArticleCategoriesReplaceWith:articleId
    categories:categories
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var categories = ; // {CategoriesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleCategoriesReplace(articleId, categories, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleCategoriesReplaceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var categories = new CategoriesCreator(); // CategoriesCreator | 

            try {
                // Replace article categories
                apiInstance.privateArticleCategoriesReplace(articleId, categories);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleCategoriesReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$categories = ; // CategoriesCreator | 

try {
    $api_instance->privateArticleCategoriesReplace($articleId, $categories);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleCategoriesReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $categories = WWW::OPenAPIClient::Object::CategoriesCreator->new(); # CategoriesCreator | 

eval {
    $api_instance->privateArticleCategoriesReplace(articleId => $articleId, categories => $categories);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleCategoriesReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
categories =  # CategoriesCreator | 

try:
    # Replace article categories
    api_instance.private_article_categories_replace(articleId, categories)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleCategoriesReplace: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let categories = ; // CategoriesCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleCategoriesReplace(articleId, categories, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
categories *

Responses


privateArticleCategoryDelete

Delete article category

De-associate category from article


/account/articles/{article_id}/categories/{category_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/categories/{category_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long categoryId = 789; // Long | Category unique identifier

        try {
            apiInstance.privateArticleCategoryDelete(articleId, categoryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoryDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long categoryId = new Long(); // Long | Category unique identifier

try {
    final result = await api_instance.privateArticleCategoryDelete(articleId, categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleCategoryDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long categoryId = 789; // Long | Category unique identifier

        try {
            apiInstance.privateArticleCategoryDelete(articleId, categoryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCategoryDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *categoryId = 789; // Category unique identifier (default to null)

// Delete article category
[apiInstance privateArticleCategoryDeleteWith:articleId
    categoryId:categoryId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var categoryId = 789; // {Long} Category unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleCategoryDelete(articleId, categoryId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleCategoryDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var categoryId = 789;  // Long | Category unique identifier (default to null)

            try {
                // Delete article category
                apiInstance.privateArticleCategoryDelete(articleId, categoryId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleCategoryDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$categoryId = 789; // Long | Category unique identifier

try {
    $api_instance->privateArticleCategoryDelete($articleId, $categoryId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleCategoryDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $categoryId = 789; # Long | Category unique identifier

eval {
    $api_instance->privateArticleCategoryDelete(articleId => $articleId, categoryId => $categoryId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleCategoryDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
categoryId = 789 # Long | Category unique identifier (default to null)

try:
    # Delete article category
    api_instance.private_article_category_delete(articleId, categoryId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleCategoryDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let categoryId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleCategoryDelete(articleId, categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
category_id*
Long (int64)
Category unique identifier
Required

Responses


privateArticleConfidentialityDelete

Delete article confidentiality

Delete confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.


/account/articles/{article_id}/confidentiality

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/confidentiality"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleConfidentialityDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleConfidentialityDelete(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleConfidentialityDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleConfidentialityDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Delete article confidentiality
[apiInstance privateArticleConfidentialityDeleteWith:articleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleConfidentialityDelete(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleConfidentialityDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Delete article confidentiality
                apiInstance.privateArticleConfidentialityDelete(articleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleConfidentialityDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $api_instance->privateArticleConfidentialityDelete($articleId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleConfidentialityDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    $api_instance->privateArticleConfidentialityDelete(articleId => $articleId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleConfidentialityDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Delete article confidentiality
    api_instance.private_article_confidentiality_delete(articleId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleConfidentialityDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleConfidentialityDelete(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleConfidentialityDetails

Article confidentiality details

View confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.


/account/articles/{article_id}/confidentiality

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/confidentiality"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleConfidentiality result = apiInstance.privateArticleConfidentialityDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleConfidentialityDetails(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleConfidentialityDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleConfidentiality result = apiInstance.privateArticleConfidentialityDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Article confidentiality details
[apiInstance privateArticleConfidentialityDetailsWith:articleId
              completionHandler: ^(ArticleConfidentiality output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleConfidentialityDetails(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleConfidentialityDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Article confidentiality details
                ArticleConfidentiality result = apiInstance.privateArticleConfidentialityDetails(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleConfidentialityDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleConfidentialityDetails($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleConfidentialityDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleConfidentialityDetails(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleConfidentialityDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Article confidentiality details
    api_response = api_instance.private_article_confidentiality_details(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleConfidentialityDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleConfidentialityDetails(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleConfidentialityUpdate

Update article confidentiality

Update confidentiality settings. The confidentiality feature is now deprecated. This has been replaced by the new extended embargo functionality and all items that used to be confidential have now been migrated to items with a permanent embargo on files. All API endpoints related to this functionality will remain for backwards compatibility, but will now be attached to the new extended embargo workflows.


/account/articles/{article_id}/confidentiality

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/confidentiality" \
 -d '{
  "reason" : "reason"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ConfidentialityCreator reason = ; // ConfidentialityCreator | 

        try {
            apiInstance.privateArticleConfidentialityUpdate(articleId, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final ConfidentialityCreator reason = new ConfidentialityCreator(); // ConfidentialityCreator | 

try {
    final result = await api_instance.privateArticleConfidentialityUpdate(articleId, reason);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleConfidentialityUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ConfidentialityCreator reason = ; // ConfidentialityCreator | 

        try {
            apiInstance.privateArticleConfidentialityUpdate(articleId, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleConfidentialityUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
ConfidentialityCreator *reason = ; // 

// Update article confidentiality
[apiInstance privateArticleConfidentialityUpdateWith:articleId
    reason:reason
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var reason = ; // {ConfidentialityCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleConfidentialityUpdate(articleId, reason, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleConfidentialityUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var reason = new ConfidentialityCreator(); // ConfidentialityCreator | 

            try {
                // Update article confidentiality
                apiInstance.privateArticleConfidentialityUpdate(articleId, reason);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleConfidentialityUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$reason = ; // ConfidentialityCreator | 

try {
    $api_instance->privateArticleConfidentialityUpdate($articleId, $reason);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleConfidentialityUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $reason = WWW::OPenAPIClient::Object::ConfidentialityCreator->new(); # ConfidentialityCreator | 

eval {
    $api_instance->privateArticleConfidentialityUpdate(articleId => $articleId, reason => $reason);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleConfidentialityUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
reason =  # ConfidentialityCreator | 

try:
    # Update article confidentiality
    api_instance.private_article_confidentiality_update(articleId, reason)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleConfidentialityUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let reason = ; // ConfidentialityCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleConfidentialityUpdate(articleId, reason, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
reason *

Responses


privateArticleCreate

Create new Article

Create a new Article by sending article information


/account/articles

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of article",
  "handle" : "",
  "title" : "Test article title",
  "tags" : [ "tag1", "tag2" ],
  "defined_type" : "media",
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "license" : 1,
  "group_id" : 6,
  "resource_doi" : "",
  "resource_title" : "",
  "is_metadata_record" : true,
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "metadata_reason" : "hosted somewhere else",
  "categories" : [ 1, 10, 11 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 1000008
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        ArticleCreate article = ; // ArticleCreate | 

        try {
            LocationWarnings result = apiInstance.privateArticleCreate(article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ArticleCreate article = new ArticleCreate(); // ArticleCreate | 

try {
    final result = await api_instance.privateArticleCreate(article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleCreate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        ArticleCreate article = ; // ArticleCreate | 

        try {
            LocationWarnings result = apiInstance.privateArticleCreate(article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
ArticleCreate *article = ; // 

// Create new Article
[apiInstance privateArticleCreateWith:article
              completionHandler: ^(LocationWarnings output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var article = ; // {ArticleCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleCreate(article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var article = new ArticleCreate(); // ArticleCreate | 

            try {
                // Create new Article
                LocationWarnings result = apiInstance.privateArticleCreate(article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$article = ; // ArticleCreate | 

try {
    $result = $api_instance->privateArticleCreate($article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $article = WWW::OPenAPIClient::Object::ArticleCreate->new(); # ArticleCreate | 

eval {
    my $result = $api_instance->privateArticleCreate(article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
article =  # ArticleCreate | 

try:
    # Create new Article
    api_response = api_instance.private_article_create(article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleCreate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let article = ; // ArticleCreate

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleCreate(article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
article *

Article description

Responses


privateArticleDelete

Delete article

Delete an article


/account/articles/{article_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleDelete(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Delete article
[apiInstance privateArticleDeleteWith:articleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleDelete(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Delete article
                apiInstance.privateArticleDelete(articleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $api_instance->privateArticleDelete($articleId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    $api_instance->privateArticleDelete(articleId => $articleId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Delete article
    api_instance.private_article_delete(articleId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleDelete(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleDetails

Article details

View a private article


/account/articles/{article_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleCompletePrivate result = apiInstance.privateArticleDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleDetails(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleCompletePrivate result = apiInstance.privateArticleDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Article details
[apiInstance privateArticleDetailsWith:articleId
              completionHandler: ^(ArticleCompletePrivate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleDetails(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Article details
                ArticleCompletePrivate result = apiInstance.privateArticleDetails(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleDetails($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleDetails(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Article details
    api_response = api_instance.private_article_details(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleDetails(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleDownload

Private Article Download

Download files from a private article preserving the folder structure


/account/articles/{article_id}/download

Usage and SDK Samples

curl -X GET \
 \
 "https://api.figsh.com/v2/account/articles/{article_id}/download?folder_path=folderPath_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.privateArticleDownload(articleId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDownload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final String folderPath = new String(); // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    final result = await api_instance.privateArticleDownload(articleId, folderPath);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleDownload: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.privateArticleDownload(articleId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleDownload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
String *folderPath = folderPath_example; // Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

// Private Article Download
[apiInstance privateArticleDownloadWith:articleId
    folderPath:folderPath
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var opts = {
  'folderPath': folderPath_example // {String} Folder path to download. If not provided, all files from the article will be downloaded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleDownload(articleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleDownloadExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var folderPath = folderPath_example;  // String | Folder path to download. If not provided, all files from the article will be downloaded (optional)  (default to null)

            try {
                // Private Article Download
                apiInstance.privateArticleDownload(articleId, folderPath);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    $api_instance->privateArticleDownload($articleId, $folderPath);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $folderPath = folderPath_example; # String | Folder path to download. If not provided, all files from the article will be downloaded

eval {
    $api_instance->privateArticleDownload(articleId => $articleId, folderPath => $folderPath);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleDownload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
folderPath = folderPath_example # String | Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

try:
    # Private Article Download
    api_instance.private_article_download(articleId, folderPath=folderPath)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleDownload: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let folderPath = folderPath_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleDownload(articleId, folderPath, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Query parameters
Name Description
folder_path
String
Folder path to download. If not provided, all files from the article will be downloaded

Responses


privateArticleEmbargoDelete

Delete Article Embargo

Will lift the embargo for the specified article


/account/articles/{article_id}/embargo

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/embargo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleEmbargoDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleEmbargoDelete(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleEmbargoDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            apiInstance.privateArticleEmbargoDelete(articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Delete Article Embargo
[apiInstance privateArticleEmbargoDeleteWith:articleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleEmbargoDelete(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleEmbargoDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Delete Article Embargo
                apiInstance.privateArticleEmbargoDelete(articleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleEmbargoDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $api_instance->privateArticleEmbargoDelete($articleId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleEmbargoDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    $api_instance->privateArticleEmbargoDelete(articleId => $articleId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleEmbargoDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Delete Article Embargo
    api_instance.private_article_embargo_delete(articleId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleEmbargoDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleEmbargoDelete(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleEmbargoDetails

Article Embargo Details

View a private article embargo details


/account/articles/{article_id}/embargo

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/embargo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleEmbargo result = apiInstance.privateArticleEmbargoDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleEmbargoDetails(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleEmbargoDetails: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleEmbargo result = apiInstance.privateArticleEmbargoDetails(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Article Embargo Details
[apiInstance privateArticleEmbargoDetailsWith:articleId
              completionHandler: ^(ArticleEmbargo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleEmbargoDetails(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleEmbargoDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Article Embargo Details
                ArticleEmbargo result = apiInstance.privateArticleEmbargoDetails(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleEmbargoDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleEmbargoDetails($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleEmbargoDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleEmbargoDetails(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleEmbargoDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Article Embargo Details
    api_response = api_instance.private_article_embargo_details(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleEmbargoDetails: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleEmbargoDetails(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleEmbargoUpdate

Update Article Embargo

Note: setting an article under whole embargo does not imply that the article will be published when the embargo will expire. You must explicitly call the publish endpoint to enable this functionality.


/account/articles/{article_id}/embargo

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/embargo" \
 -d '{
  "embargo_type" : "file",
  "is_embargoed" : true,
  "embargo_date" : "2018-05-22T04:04:04",
  "embargo_title" : "File(s) under embargo",
  "embargo_reason" : "",
  "embargo_options" : [ {
    "id" : 1321
  }, {
    "id" : 3345
  }, {
    "id" : 54621,
    "group_ids" : [ 4332, 5433, 678 ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleEmbargoUpdater embargo = ; // ArticleEmbargoUpdater | 

        try {
            apiInstance.privateArticleEmbargoUpdate(articleId, embargo);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final ArticleEmbargoUpdater embargo = new ArticleEmbargoUpdater(); // ArticleEmbargoUpdater | 

try {
    final result = await api_instance.privateArticleEmbargoUpdate(articleId, embargo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleEmbargoUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleEmbargoUpdater embargo = ; // ArticleEmbargoUpdater | 

        try {
            apiInstance.privateArticleEmbargoUpdate(articleId, embargo);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleEmbargoUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
ArticleEmbargoUpdater *embargo = ; // 

// Update Article Embargo
[apiInstance privateArticleEmbargoUpdateWith:articleId
    embargo:embargo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var embargo = ; // {ArticleEmbargoUpdater} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleEmbargoUpdate(articleId, embargo, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleEmbargoUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var embargo = new ArticleEmbargoUpdater(); // ArticleEmbargoUpdater | 

            try {
                // Update Article Embargo
                apiInstance.privateArticleEmbargoUpdate(articleId, embargo);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleEmbargoUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$embargo = ; // ArticleEmbargoUpdater | 

try {
    $api_instance->privateArticleEmbargoUpdate($articleId, $embargo);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleEmbargoUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $embargo = WWW::OPenAPIClient::Object::ArticleEmbargoUpdater->new(); # ArticleEmbargoUpdater | 

eval {
    $api_instance->privateArticleEmbargoUpdate(articleId => $articleId, embargo => $embargo);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleEmbargoUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
embargo =  # ArticleEmbargoUpdater | 

try:
    # Update Article Embargo
    api_instance.private_article_embargo_update(articleId, embargo)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleEmbargoUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let embargo = ; // ArticleEmbargoUpdater

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleEmbargoUpdate(articleId, embargo, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
embargo *

Embargo description

Responses

Name Type Format Description
Location String link Location of project


privateArticleFile

Single File

View details of file for specified article


/account/articles/{article_id}/files/{file_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/files/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            PrivateFile result = apiInstance.privateArticleFile(articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long fileId = new Long(); // Long | File unique identifier

try {
    final result = await api_instance.privateArticleFile(articleId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleFile: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            PrivateFile result = apiInstance.privateArticleFile(articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *fileId = 789; // File unique identifier (default to null)

// Single File
[apiInstance privateArticleFileWith:articleId
    fileId:fileId
              completionHandler: ^(PrivateFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var fileId = 789; // {Long} File unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleFile(articleId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleFileExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var fileId = 789;  // Long | File unique identifier (default to null)

            try {
                // Single File
                PrivateFile result = apiInstance.privateArticleFile(articleId, fileId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$fileId = 789; // Long | File unique identifier

try {
    $result = $api_instance->privateArticleFile($articleId, $fileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $fileId = 789; # Long | File unique identifier

eval {
    my $result = $api_instance->privateArticleFile(articleId => $articleId, fileId => $fileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
fileId = 789 # Long | File unique identifier (default to null)

try:
    # Single File
    api_response = api_instance.private_article_file(articleId, fileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleFile: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let fileId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleFile(articleId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
file_id*
Long (int64)
File unique identifier
Required

Responses


privateArticleFileDelete

File Delete

Complete file upload


/account/articles/{article_id}/files/{file_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/files/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            apiInstance.privateArticleFileDelete(articleId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFileDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long fileId = new Long(); // Long | File unique identifier

try {
    final result = await api_instance.privateArticleFileDelete(articleId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleFileDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            apiInstance.privateArticleFileDelete(articleId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFileDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *fileId = 789; // File unique identifier (default to null)

// File Delete
[apiInstance privateArticleFileDeleteWith:articleId
    fileId:fileId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var fileId = 789; // {Long} File unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleFileDelete(articleId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleFileDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var fileId = 789;  // Long | File unique identifier (default to null)

            try {
                // File Delete
                apiInstance.privateArticleFileDelete(articleId, fileId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleFileDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$fileId = 789; // Long | File unique identifier

try {
    $api_instance->privateArticleFileDelete($articleId, $fileId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleFileDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $fileId = 789; # Long | File unique identifier

eval {
    $api_instance->privateArticleFileDelete(articleId => $articleId, fileId => $fileId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleFileDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
fileId = 789 # Long | File unique identifier (default to null)

try:
    # File Delete
    api_instance.private_article_file_delete(articleId, fileId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleFileDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let fileId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleFileDelete(articleId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
file_id*
Long (int64)
File unique identifier
Required

Responses


privateArticleFilesList

List article files

List private files


/account/articles/{article_id}/files

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/files?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PrivateFile] result = apiInstance.privateArticleFilesList(articleId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFilesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.privateArticleFilesList(articleId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleFilesList: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[PrivateFile] result = apiInstance.privateArticleFilesList(articleId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleFilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// List article files
[apiInstance privateArticleFilesListWith:articleId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[PrivateFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleFilesList(articleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleFilesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // List article files
                array[PrivateFile] result = apiInstance.privateArticleFilesList(articleId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleFilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->privateArticleFilesList($articleId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleFilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->privateArticleFilesList(articleId => $articleId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleFilesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # List article files
    api_response = api_instance.private_article_files_list(articleId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleFilesList: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleFilesList(articleId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


privateArticlePartialUpdate

Partially update article

Partially update an article by sending only the fields to change.


/account/articles/{article_id}

Usage and SDK Samples

curl -X PATCH \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "download_disabled" : false,
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of article",
  "handle" : "",
  "title" : "Test article title",
  "tags" : [ "tag1", "tag2" ],
  "defined_type" : "media",
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "license" : 1,
  "group_id" : 0,
  "resource_doi" : "",
  "resource_title" : "",
  "is_metadata_record" : true,
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "metadata_reason" : "hosted somewhere else",
  "categories" : [ 1, 10, 11 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 1000008
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUpdate article = ; // ArticleUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateArticlePartialUpdate(articleId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePartialUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final ArticleUpdate article = new ArticleUpdate(); // ArticleUpdate | 

try {
    final result = await api_instance.privateArticlePartialUpdate(articleId, article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlePartialUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUpdate article = ; // ArticleUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateArticlePartialUpdate(articleId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
ArticleUpdate *article = ; // 

// Partially update article
[apiInstance privateArticlePartialUpdateWith:articleId
    article:article
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var article = ; // {ArticleUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticlePartialUpdate(articleId, article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlePartialUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var article = new ArticleUpdate(); // ArticleUpdate | 

            try {
                // Partially update article
                LocationWarningsUpdate result = apiInstance.privateArticlePartialUpdate(articleId, article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlePartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$article = ; // ArticleUpdate | 

try {
    $result = $api_instance->privateArticlePartialUpdate($articleId, $article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlePartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $article = WWW::OPenAPIClient::Object::ArticleUpdate->new(); # ArticleUpdate | 

eval {
    my $result = $api_instance->privateArticlePartialUpdate(articleId => $articleId, article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlePartialUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
article =  # ArticleUpdate | 

try:
    # Partially update article
    api_response = api_instance.private_article_partial_update(articleId, article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlePartialUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let article = ; // ArticleUpdate

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlePartialUpdate(articleId, article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
article *

Subset of article fields to update

Responses

Name Type Format Description
Location String link Location of project



privateArticlePrivateLinkCreate

Create private link

Create new private link for this article


/account/articles/{article_id}/private_links

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/private_links" \
 -d '{
  "expires_date" : "2018-02-22 22:22:22"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        PrivateLinkCreator privateLink = ; // PrivateLinkCreator | 

        try {
            PrivateLinkResponse result = apiInstance.privateArticlePrivateLinkCreate(articleId, privateLink);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final PrivateLinkCreator privateLink = new PrivateLinkCreator(); // PrivateLinkCreator | 

try {
    final result = await api_instance.privateArticlePrivateLinkCreate(articleId, privateLink);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlePrivateLinkCreate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        PrivateLinkCreator privateLink = ; // PrivateLinkCreator | 

        try {
            PrivateLinkResponse result = apiInstance.privateArticlePrivateLinkCreate(articleId, privateLink);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
PrivateLinkCreator *privateLink = ; //  (optional)

// Create private link
[apiInstance privateArticlePrivateLinkCreateWith:articleId
    privateLink:privateLink
              completionHandler: ^(PrivateLinkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var opts = {
  'privateLink':  // {PrivateLinkCreator} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticlePrivateLinkCreate(articleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlePrivateLinkCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var privateLink = new PrivateLinkCreator(); // PrivateLinkCreator |  (optional) 

            try {
                // Create private link
                PrivateLinkResponse result = apiInstance.privateArticlePrivateLinkCreate(articleId, privateLink);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlePrivateLinkCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$privateLink = ; // PrivateLinkCreator | 

try {
    $result = $api_instance->privateArticlePrivateLinkCreate($articleId, $privateLink);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlePrivateLinkCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $privateLink = WWW::OPenAPIClient::Object::PrivateLinkCreator->new(); # PrivateLinkCreator | 

eval {
    my $result = $api_instance->privateArticlePrivateLinkCreate(articleId => $articleId, privateLink => $privateLink);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlePrivateLinkCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
privateLink =  # PrivateLinkCreator |  (optional)

try:
    # Create private link
    api_response = api_instance.private_article_private_link_create(articleId, privateLink=privateLink)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlePrivateLinkCreate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let privateLink = ; // PrivateLinkCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlePrivateLinkCreate(articleId, privateLink, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
privateLink

Responses

Name Type Format Description
Location String url Location of article


privateArticlePrivateLinkDelete

Disable private link

Disable/delete private link for this article


/account/articles/{article_id}/private_links/{link_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/private_links/{link_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            apiInstance.privateArticlePrivateLinkDelete(articleId, linkId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final String linkId = new String(); // String | Private link token

try {
    final result = await api_instance.privateArticlePrivateLinkDelete(articleId, linkId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlePrivateLinkDelete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            apiInstance.privateArticlePrivateLinkDelete(articleId, linkId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
String *linkId = linkId_example; // Private link token (default to null)

// Disable private link
[apiInstance privateArticlePrivateLinkDeleteWith:articleId
    linkId:linkId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var linkId = linkId_example; // {String} Private link token

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticlePrivateLinkDelete(articleId, linkId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlePrivateLinkDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var linkId = linkId_example;  // String | Private link token (default to null)

            try {
                // Disable private link
                apiInstance.privateArticlePrivateLinkDelete(articleId, linkId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlePrivateLinkDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$linkId = linkId_example; // String | Private link token

try {
    $api_instance->privateArticlePrivateLinkDelete($articleId, $linkId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlePrivateLinkDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $linkId = linkId_example; # String | Private link token

eval {
    $api_instance->privateArticlePrivateLinkDelete(articleId => $articleId, linkId => $linkId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlePrivateLinkDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
linkId = linkId_example # String | Private link token (default to null)

try:
    # Disable private link
    api_instance.private_article_private_link_delete(articleId, linkId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlePrivateLinkDelete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let linkId = linkId_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlePrivateLinkDelete(articleId, linkId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
link_id*
String
Private link token
Required

Responses


privateArticlePrivateLinkUpdate

Update private link

Update existing private link for this article


/account/articles/{article_id}/private_links/{link_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/private_links/{link_id}" \
 -d '{
  "expires_date" : "2018-02-22 22:22:22"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String linkId = linkId_example; // String | Private link token
        PrivateLinkCreator privateLink = ; // PrivateLinkCreator | 

        try {
            apiInstance.privateArticlePrivateLinkUpdate(articleId, linkId, privateLink);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final String linkId = new String(); // String | Private link token
final PrivateLinkCreator privateLink = new PrivateLinkCreator(); // PrivateLinkCreator | 

try {
    final result = await api_instance.privateArticlePrivateLinkUpdate(articleId, linkId, privateLink);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlePrivateLinkUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String linkId = linkId_example; // String | Private link token
        PrivateLinkCreator privateLink = ; // PrivateLinkCreator | 

        try {
            apiInstance.privateArticlePrivateLinkUpdate(articleId, linkId, privateLink);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlePrivateLinkUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
String *linkId = linkId_example; // Private link token (default to null)
PrivateLinkCreator *privateLink = ; //  (optional)

// Update private link
[apiInstance privateArticlePrivateLinkUpdateWith:articleId
    linkId:linkId
    privateLink:privateLink
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var linkId = linkId_example; // {String} Private link token
var opts = {
  'privateLink':  // {PrivateLinkCreator} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticlePrivateLinkUpdate(articleId, linkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlePrivateLinkUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var linkId = linkId_example;  // String | Private link token (default to null)
            var privateLink = new PrivateLinkCreator(); // PrivateLinkCreator |  (optional) 

            try {
                // Update private link
                apiInstance.privateArticlePrivateLinkUpdate(articleId, linkId, privateLink);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlePrivateLinkUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$linkId = linkId_example; // String | Private link token
$privateLink = ; // PrivateLinkCreator | 

try {
    $api_instance->privateArticlePrivateLinkUpdate($articleId, $linkId, $privateLink);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlePrivateLinkUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $linkId = linkId_example; # String | Private link token
my $privateLink = WWW::OPenAPIClient::Object::PrivateLinkCreator->new(); # PrivateLinkCreator | 

eval {
    $api_instance->privateArticlePrivateLinkUpdate(articleId => $articleId, linkId => $linkId, privateLink => $privateLink);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlePrivateLinkUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
linkId = linkId_example # String | Private link token (default to null)
privateLink =  # PrivateLinkCreator |  (optional)

try:
    # Update private link
    api_instance.private_article_private_link_update(articleId, linkId, privateLink=privateLink)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlePrivateLinkUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let linkId = linkId_example; // String
    let privateLink = ; // PrivateLinkCreator

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlePrivateLinkUpdate(articleId, linkId, privateLink, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
link_id*
String
Private link token
Required
Body parameters
Name Description
privateLink

Responses

Name Type Format Description
Location String url Location of article


privateArticleReserveDoi

Private Article Reserve DOI

Reserve DOI for article


/account/articles/{article_id}/reserve_doi

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/reserve_doi"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleDOI result = apiInstance.privateArticleReserveDoi(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleReserveDoi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleReserveDoi(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleReserveDoi: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleDOI result = apiInstance.privateArticleReserveDoi(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleReserveDoi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Private Article Reserve DOI
[apiInstance privateArticleReserveDoiWith:articleId
              completionHandler: ^(ArticleDOI output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleReserveDoi(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleReserveDoiExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Private Article Reserve DOI
                ArticleDOI result = apiInstance.privateArticleReserveDoi(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleReserveDoi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleReserveDoi($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleReserveDoi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleReserveDoi(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleReserveDoi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Private Article Reserve DOI
    api_response = api_instance.private_article_reserve_doi(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleReserveDoi: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleReserveDoi(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleReserveHandle

Private Article Reserve Handle

Reserve Handle for article


/account/articles/{article_id}/reserve_handle

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/reserve_handle"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleHandle result = apiInstance.privateArticleReserveHandle(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleReserveHandle");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier

try {
    final result = await api_instance.privateArticleReserveHandle(articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleReserveHandle: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier

        try {
            ArticleHandle result = apiInstance.privateArticleReserveHandle(articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleReserveHandle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)

// Private Article Reserve Handle
[apiInstance privateArticleReserveHandleWith:articleId
              completionHandler: ^(ArticleHandle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleReserveHandle(articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleReserveHandleExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)

            try {
                // Private Article Reserve Handle
                ArticleHandle result = apiInstance.privateArticleReserveHandle(articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleReserveHandle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier

try {
    $result = $api_instance->privateArticleReserveHandle($articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleReserveHandle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier

eval {
    my $result = $api_instance->privateArticleReserveHandle(articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleReserveHandle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)

try:
    # Private Article Reserve Handle
    api_response = api_instance.private_article_reserve_handle(articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleReserveHandle: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleReserveHandle(articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required

Responses


privateArticleResource

Private Article Resource

Edit article resource data.


/account/articles/{article_id}/resource

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/resource" \
 -d '{
  "link" : "https://docs.figshare.com",
  "id" : "aaaa23512",
  "title" : "Test title",
  "version" : 1,
  "doi" : "",
  "status" : "frozen"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Resource resource = ; // Resource | 

        try {
            Location result = apiInstance.privateArticleResource(articleId, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleResource");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Resource resource = new Resource(); // Resource | 

try {
    final result = await api_instance.privateArticleResource(articleId, resource);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleResource: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Resource resource = ; // Resource | 

        try {
            Location result = apiInstance.privateArticleResource(articleId, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleResource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Resource *resource = ; // 

// Private Article Resource
[apiInstance privateArticleResourceWith:articleId
    resource:resource
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var resource = ; // {Resource} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleResource(articleId, resource, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleResourceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var resource = new Resource(); // Resource | 

            try {
                // Private Article Resource
                Location result = apiInstance.privateArticleResource(articleId, resource);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$resource = ; // Resource | 

try {
    $result = $api_instance->privateArticleResource($articleId, $resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $resource = WWW::OPenAPIClient::Object::Resource->new(); # Resource | 

eval {
    my $result = $api_instance->privateArticleResource(articleId => $articleId, resource => $resource);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleResource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
resource =  # Resource | 

try:
    # Private Article Resource
    api_response = api_instance.private_article_resource(articleId, resource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleResource: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let resource = ; // Resource

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleResource(articleId, resource, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
resource *

Resource data

Responses

Name Type Format Description
Location String link Location of project


privateArticleUpdate

Update article

Update an article by passing full body parameters.


/account/articles/{article_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "download_disabled" : false,
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of article",
  "handle" : "",
  "title" : "Test article title",
  "tags" : [ "tag1", "tag2" ],
  "defined_type" : "media",
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "license" : 1,
  "group_id" : 0,
  "resource_doi" : "",
  "resource_title" : "",
  "is_metadata_record" : true,
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "metadata_reason" : "hosted somewhere else",
  "categories" : [ 1, 10, 11 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 1000008
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUpdate article = ; // ArticleUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateArticleUpdate(articleId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final ArticleUpdate article = new ArticleUpdate(); // ArticleUpdate | 

try {
    final result = await api_instance.privateArticleUpdate(articleId, article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleUpdate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        ArticleUpdate article = ; // ArticleUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateArticleUpdate(articleId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
ArticleUpdate *article = ; // 

// Update article
[apiInstance privateArticleUpdateWith:articleId
    article:article
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var article = ; // {ArticleUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleUpdate(articleId, article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var article = new ArticleUpdate(); // ArticleUpdate | 

            try {
                // Update article
                LocationWarningsUpdate result = apiInstance.privateArticleUpdate(articleId, article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$article = ; // ArticleUpdate | 

try {
    $result = $api_instance->privateArticleUpdate($articleId, $article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $article = WWW::OPenAPIClient::Object::ArticleUpdate->new(); # ArticleUpdate | 

eval {
    my $result = $api_instance->privateArticleUpdate(articleId => $articleId, article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
article =  # ArticleUpdate | 

try:
    # Update article
    api_response = api_instance.private_article_update(articleId, article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleUpdate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let article = ; // ArticleUpdate

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleUpdate(articleId, article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
article *

Full article representation

Responses

Name Type Format Description
Location String link Location of project


privateArticleUploadComplete

Complete Upload

Complete file upload


/account/articles/{article_id}/files/{file_id}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/files/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            apiInstance.privateArticleUploadComplete(articleId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUploadComplete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long fileId = new Long(); // Long | File unique identifier

try {
    final result = await api_instance.privateArticleUploadComplete(articleId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleUploadComplete: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            apiInstance.privateArticleUploadComplete(articleId, fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUploadComplete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *fileId = 789; // File unique identifier (default to null)

// Complete Upload
[apiInstance privateArticleUploadCompleteWith:articleId
    fileId:fileId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var fileId = 789; // {Long} File unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateArticleUploadComplete(articleId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleUploadCompleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var fileId = 789;  // Long | File unique identifier (default to null)

            try {
                // Complete Upload
                apiInstance.privateArticleUploadComplete(articleId, fileId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleUploadComplete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$fileId = 789; // Long | File unique identifier

try {
    $api_instance->privateArticleUploadComplete($articleId, $fileId);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleUploadComplete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $fileId = 789; # Long | File unique identifier

eval {
    $api_instance->privateArticleUploadComplete(articleId => $articleId, fileId => $fileId);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleUploadComplete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
fileId = 789 # Long | File unique identifier (default to null)

try:
    # Complete Upload
    api_instance.private_article_upload_complete(articleId, fileId)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleUploadComplete: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let fileId = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleUploadComplete(articleId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
file_id*
Long (int64)
File unique identifier
Required

Responses


privateArticleUploadInitiate

Initiate Upload

Initiate a new file upload within the article. Either use the link property to point to an existing file that resides elsewhere and will not be uploaded to Figshare or use the other 3 parameters (md5, name, size).


/account/articles/{article_id}/files

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/{article_id}/files?page=789&page_size=789&limit=789&offset=789" \
 -d '{
  "size" : 70,
  "link" : "http://figshare.com/file.txt",
  "name" : "test.py",
  "folder_path" : "/level1/level2/level3",
  "md5" : "6c16e6e7d7587bd078e5117dda01d565"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        FileCreator file = ; // FileCreator | 
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            Location result = apiInstance.privateArticleUploadInitiate(articleId, file, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUploadInitiate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final FileCreator file = new FileCreator(); // FileCreator | 
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.privateArticleUploadInitiate(articleId, file, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticleUploadInitiate: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        FileCreator file = ; // FileCreator | 
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            Location result = apiInstance.privateArticleUploadInitiate(articleId, file, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticleUploadInitiate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
FileCreator *file = ; // 
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Initiate Upload
[apiInstance privateArticleUploadInitiateWith:articleId
    file:file
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var file = ; // {FileCreator} 
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticleUploadInitiate(articleId, file, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticleUploadInitiateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var file = new FileCreator(); // FileCreator | 
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Initiate Upload
                Location result = apiInstance.privateArticleUploadInitiate(articleId, file, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticleUploadInitiate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$file = ; // FileCreator | 
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->privateArticleUploadInitiate($articleId, $file, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticleUploadInitiate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $file = WWW::OPenAPIClient::Object::FileCreator->new(); # FileCreator | 
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->privateArticleUploadInitiate(articleId => $articleId, file => $file, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticleUploadInitiate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
file =  # FileCreator | 
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Initiate Upload
    api_response = api_instance.private_article_upload_initiate(articleId, file, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticleUploadInitiate: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let file = ; // FileCreator
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticleUploadInitiate(articleId, file, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Body parameters
Name Description
file *

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses

Name Type Format Description
Location String url Location of article


privateArticlesList

Private Articles

Get Own Articles


/account/articles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/articles?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.privateArticlesList(page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.privateArticlesList(page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlesList: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.privateArticlesList(page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Private Articles
[apiInstance privateArticlesListWith:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticlesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Private Articles
                array[Article] result = apiInstance.privateArticlesList(page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->privateArticlesList($page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->privateArticlesList(page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Private Articles
    api_response = api_instance.private_articles_list(page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlesList: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlesList(page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


privateArticlesSearch

Private Articles search

Returns a list of private articles filtered by the search parameters


/account/articles/search

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/articles/search" \
 -d '{
  "resource_id" : "1407024"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        PrivateArticleSearch search = ; // PrivateArticleSearch | 

        try {
            array[ArticleWithProject] result = apiInstance.privateArticlesSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlesSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PrivateArticleSearch search = new PrivateArticleSearch(); // PrivateArticleSearch | 

try {
    final result = await api_instance.privateArticlesSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateArticlesSearch: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        PrivateArticleSearch search = ; // PrivateArticleSearch | 

        try {
            array[ArticleWithProject] result = apiInstance.privateArticlesSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#privateArticlesSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
PrivateArticleSearch *search = ; // 

// Private Articles search
[apiInstance privateArticlesSearchWith:search
              completionHandler: ^(array[ArticleWithProject] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var search = ; // {PrivateArticleSearch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateArticlesSearch(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateArticlesSearchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var search = new PrivateArticleSearch(); // PrivateArticleSearch | 

            try {
                // Private Articles search
                array[ArticleWithProject] result = apiInstance.privateArticlesSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.privateArticlesSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$search = ; // PrivateArticleSearch | 

try {
    $result = $api_instance->privateArticlesSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->privateArticlesSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $search = WWW::OPenAPIClient::Object::PrivateArticleSearch->new(); # PrivateArticleSearch | 

eval {
    my $result = $api_instance->privateArticlesSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArticlesApi->privateArticlesSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
search =  # PrivateArticleSearch | 

try:
    # Private Articles search
    api_response = api_instance.private_articles_search(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArticlesApi->privateArticlesSearch: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let search = ; // PrivateArticleSearch

    let mut context = ArticlesApi::Context::default();
    let result = client.privateArticlesSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
search *

Search Parameters

Responses


publicArticleDownload

Public Article Download

Download files from a public article preserving the folder structure


/articles/{article_id}/download

Usage and SDK Samples

curl -X GET \
 "https://api.figsh.com/v2/articles/{article_id}/download?folder_path=folderPath_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.publicArticleDownload(articleId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#publicArticleDownload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final String folderPath = new String(); // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    final result = await api_instance.publicArticleDownload(articleId, folderPath);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->publicArticleDownload: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.publicArticleDownload(articleId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#publicArticleDownload");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
String *folderPath = folderPath_example; // Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

// Public Article Download
[apiInstance publicArticleDownloadWith:articleId
    folderPath:folderPath
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var opts = {
  'folderPath': folderPath_example // {String} Folder path to download. If not provided, all files from the article will be downloaded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.publicArticleDownload(articleId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class publicArticleDownloadExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var folderPath = folderPath_example;  // String | Folder path to download. If not provided, all files from the article will be downloaded (optional)  (default to null)

            try {
                // Public Article Download
                apiInstance.publicArticleDownload(articleId, folderPath);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.publicArticleDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    $api_instance->publicArticleDownload($articleId, $folderPath);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->publicArticleDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $folderPath = folderPath_example; # String | Folder path to download. If not provided, all files from the article will be downloaded

eval {
    $api_instance->publicArticleDownload(articleId => $articleId, folderPath => $folderPath);
};
if ($@) {
    warn "Exception when calling ArticlesApi->publicArticleDownload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
folderPath = folderPath_example # String | Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

try:
    # Public Article Download
    api_instance.public_article_download(articleId, folderPath=folderPath)
except ApiException as e:
    print("Exception when calling ArticlesApi->publicArticleDownload: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let folderPath = folderPath_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.publicArticleDownload(articleId, folderPath, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
Query parameters
Name Description
folder_path
String
Folder path to download. If not provided, all files from the article will be downloaded

Responses


publicArticleVersionDownload

Public Article Version Download

Download files from a certain version of an public article preserving the folder structure


/articles/{article_id}/versions/{version_id}/download

Usage and SDK Samples

curl -X GET \
 "https://api.figsh.com/v2/articles/{article_id}/versions/{version_id}/download?folder_path=folderPath_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ArticlesApi;

import java.io.File;
import java.util.*;

public class ArticlesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Version Number
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.publicArticleVersionDownload(articleId, versionId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#publicArticleVersionDownload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long articleId = new Long(); // Long | Article unique identifier
final Long versionId = new Long(); // Long | Version Number
final String folderPath = new String(); // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    final result = await api_instance.publicArticleVersionDownload(articleId, versionId, folderPath);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->publicArticleVersionDownload: $e\n');
}

import org.openapitools.client.api.ArticlesApi;

public class ArticlesApiExample {
    public static void main(String[] args) {
        ArticlesApi apiInstance = new ArticlesApi();
        Long articleId = 789; // Long | Article unique identifier
        Long versionId = 789; // Long | Version Number
        String folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

        try {
            apiInstance.publicArticleVersionDownload(articleId, versionId, folderPath);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArticlesApi#publicArticleVersionDownload");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ArticlesApi *apiInstance = [[ArticlesApi alloc] init];
Long *articleId = 789; // Article unique identifier (default to null)
Long *versionId = 789; // Version Number (default to null)
String *folderPath = folderPath_example; // Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

// Public Article Version Download
[apiInstance publicArticleVersionDownloadWith:articleId
    versionId:versionId
    folderPath:folderPath
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ArticlesApi()
var articleId = 789; // {Long} Article unique identifier
var versionId = 789; // {Long} Version Number
var opts = {
  'folderPath': folderPath_example // {String} Folder path to download. If not provided, all files from the article will be downloaded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.publicArticleVersionDownload(articleId, versionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class publicArticleVersionDownloadExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ArticlesApi();
            var articleId = 789;  // Long | Article unique identifier (default to null)
            var versionId = 789;  // Long | Version Number (default to null)
            var folderPath = folderPath_example;  // String | Folder path to download. If not provided, all files from the article will be downloaded (optional)  (default to null)

            try {
                // Public Article Version Download
                apiInstance.publicArticleVersionDownload(articleId, versionId, folderPath);
            } catch (Exception e) {
                Debug.Print("Exception when calling ArticlesApi.publicArticleVersionDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ArticlesApi();
$articleId = 789; // Long | Article unique identifier
$versionId = 789; // Long | Version Number
$folderPath = folderPath_example; // String | Folder path to download. If not provided, all files from the article will be downloaded

try {
    $api_instance->publicArticleVersionDownload($articleId, $versionId, $folderPath);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->publicArticleVersionDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ArticlesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ArticlesApi->new();
my $articleId = 789; # Long | Article unique identifier
my $versionId = 789; # Long | Version Number
my $folderPath = folderPath_example; # String | Folder path to download. If not provided, all files from the article will be downloaded

eval {
    $api_instance->publicArticleVersionDownload(articleId => $articleId, versionId => $versionId, folderPath => $folderPath);
};
if ($@) {
    warn "Exception when calling ArticlesApi->publicArticleVersionDownload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ArticlesApi()
articleId = 789 # Long | Article unique identifier (default to null)
versionId = 789 # Long | Version Number (default to null)
folderPath = folderPath_example # String | Folder path to download. If not provided, all files from the article will be downloaded (optional) (default to null)

try:
    # Public Article Version Download
    api_instance.public_article_version_download(articleId, versionId, folderPath=folderPath)
except ApiException as e:
    print("Exception when calling ArticlesApi->publicArticleVersionDownload: %s\n" % e)
extern crate ArticlesApi;

pub fn main() {
    let articleId = 789; // Long
    let versionId = 789; // Long
    let folderPath = folderPath_example; // String

    let mut context = ArticlesApi::Context::default();
    let result = client.publicArticleVersionDownload(articleId, versionId, folderPath, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
article_id*
Long (int64)
Article unique identifier
Required
version_id*
Long (int64)
Version Number
Required
Query parameters
Name Description
folder_path
String
Folder path to download. If not provided, all files from the article will be downloaded

Responses


Authors

privateAuthorDetails

Author details

View author details


/account/authors/{author_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/authors/{author_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorsApi;

import java.io.File;
import java.util.*;

public class AuthorsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        AuthorsApi apiInstance = new AuthorsApi();
        Long authorId = 789; // Long | Author unique identifier

        try {
            AuthorComplete result = apiInstance.privateAuthorDetails(authorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorsApi#privateAuthorDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long authorId = new Long(); // Long | Author unique identifier

try {
    final result = await api_instance.privateAuthorDetails(authorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateAuthorDetails: $e\n');
}

import org.openapitools.client.api.AuthorsApi;

public class AuthorsApiExample {
    public static void main(String[] args) {
        AuthorsApi apiInstance = new AuthorsApi();
        Long authorId = 789; // Long | Author unique identifier

        try {
            AuthorComplete result = apiInstance.privateAuthorDetails(authorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorsApi#privateAuthorDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
AuthorsApi *apiInstance = [[AuthorsApi alloc] init];
Long *authorId = 789; // Author unique identifier (default to null)

// Author details
[apiInstance privateAuthorDetailsWith:authorId
              completionHandler: ^(AuthorComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.AuthorsApi()
var authorId = 789; // {Long} Author unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateAuthorDetails(authorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateAuthorDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthorsApi();
            var authorId = 789;  // Long | Author unique identifier (default to null)

            try {
                // Author details
                AuthorComplete result = apiInstance.privateAuthorDetails(authorId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorsApi.privateAuthorDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorsApi();
$authorId = 789; // Long | Author unique identifier

try {
    $result = $api_instance->privateAuthorDetails($authorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorsApi->privateAuthorDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorsApi->new();
my $authorId = 789; # Long | Author unique identifier

eval {
    my $result = $api_instance->privateAuthorDetails(authorId => $authorId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorsApi->privateAuthorDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthorsApi()
authorId = 789 # Long | Author unique identifier (default to null)

try:
    # Author details
    api_response = api_instance.private_author_details(authorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorsApi->privateAuthorDetails: %s\n" % e)
extern crate AuthorsApi;

pub fn main() {
    let authorId = 789; // Long

    let mut context = AuthorsApi::Context::default();
    let result = client.privateAuthorDetails(authorId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
author_id*
Long (int64)
Author unique identifier
Required

Responses


privateAuthorsSearch

Search Authors

Search for authors


/account/authors/search

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/authors/search" \
 -d '{
  "is_active" : true,
  "offset" : 0,
  "group_id" : 0,
  "limit" : 10,
  "is_public" : true,
  "orcid" : "orcid",
  "page" : 1,
  "search_for" : "figshare",
  "page_size" : 10,
  "institution_id" : 1
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorsApi;

import java.io.File;
import java.util.*;

public class AuthorsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        AuthorsApi apiInstance = new AuthorsApi();
        PrivateAuthorsSearch search = ; // PrivateAuthorsSearch | 

        try {
            array[AuthorComplete] result = apiInstance.privateAuthorsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorsApi#privateAuthorsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PrivateAuthorsSearch search = new PrivateAuthorsSearch(); // PrivateAuthorsSearch | 

try {
    final result = await api_instance.privateAuthorsSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateAuthorsSearch: $e\n');
}

import org.openapitools.client.api.AuthorsApi;

public class AuthorsApiExample {
    public static void main(String[] args) {
        AuthorsApi apiInstance = new AuthorsApi();
        PrivateAuthorsSearch search = ; // PrivateAuthorsSearch | 

        try {
            array[AuthorComplete] result = apiInstance.privateAuthorsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorsApi#privateAuthorsSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
AuthorsApi *apiInstance = [[AuthorsApi alloc] init];
PrivateAuthorsSearch *search = ; //  (optional)

// Search Authors
[apiInstance privateAuthorsSearchWith:search
              completionHandler: ^(array[AuthorComplete] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.AuthorsApi()
var opts = {
  'search':  // {PrivateAuthorsSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateAuthorsSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateAuthorsSearchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthorsApi();
            var search = new PrivateAuthorsSearch(); // PrivateAuthorsSearch |  (optional) 

            try {
                // Search Authors
                array[AuthorComplete] result = apiInstance.privateAuthorsSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorsApi.privateAuthorsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorsApi();
$search = ; // PrivateAuthorsSearch | 

try {
    $result = $api_instance->privateAuthorsSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthorsApi->privateAuthorsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthorsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthorsApi->new();
my $search = WWW::OPenAPIClient::Object::PrivateAuthorsSearch->new(); # PrivateAuthorsSearch | 

eval {
    my $result = $api_instance->privateAuthorsSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorsApi->privateAuthorsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthorsApi()
search =  # PrivateAuthorsSearch |  (optional)

try:
    # Search Authors
    api_response = api_instance.private_authors_search(search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorsApi->privateAuthorsSearch: %s\n" % e)
extern crate AuthorsApi;

pub fn main() {
    let search = ; // PrivateAuthorsSearch

    let mut context = AuthorsApi::Context::default();
    let result = client.privateAuthorsSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
search

Search Parameters

Responses


Collections

collectionArticles

Public Collection Articles

Returns a list of public collection articles


/collections/{collection_id}/articles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/collections/{collection_id}/articles?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.collectionArticles(collectionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionArticles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.collectionArticles(collectionId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionArticles: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.collectionArticles(collectionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionArticles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Public Collection Articles
[apiInstance collectionArticlesWith:collectionId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionArticles(collectionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionArticlesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Public Collection Articles
                array[Article] result = apiInstance.collectionArticles(collectionId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionArticles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->collectionArticles($collectionId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionArticles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->collectionArticles(collectionId => $collectionId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionArticles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Public Collection Articles
    api_response = api_instance.collection_articles(collectionId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionArticles: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionArticles(collectionId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


collectionDetails

Collection details

View a collection


/collections/{collection_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/collections/{collection_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionComplete result = apiInstance.collectionDetails(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.collectionDetails(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionDetails: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionComplete result = apiInstance.collectionDetails(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Collection details
[apiInstance collectionDetailsWith:collectionId
              completionHandler: ^(CollectionComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionDetails(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Collection details
                CollectionComplete result = apiInstance.collectionDetails(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->collectionDetails($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->collectionDetails(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Collection details
    api_response = api_instance.collection_details(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionDetails: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionDetails(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


collectionVersionDetails

Collection Version details

View details for a certain version of a collection


/collections/{collection_id}/versions/{version_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/collections/{collection_id}/versions/{version_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            CollectionComplete result = apiInstance.collectionVersionDetails(collectionId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionVersionDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier
final Long versionId = new Long(); // Long | Version Number

try {
    final result = await api_instance.collectionVersionDetails(collectionId, versionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionVersionDetails: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        Long versionId = 789; // Long | Version Number

        try {
            CollectionComplete result = apiInstance.collectionVersionDetails(collectionId, versionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionVersionDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)
Long *versionId = 789; // Version Number (default to null)

// Collection Version details
[apiInstance collectionVersionDetailsWith:collectionId
    versionId:versionId
              completionHandler: ^(CollectionComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier
var versionId = 789; // {Long} Version Number

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionVersionDetails(collectionId, versionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionVersionDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)
            var versionId = 789;  // Long | Version Number (default to null)

            try {
                // Collection Version details
                CollectionComplete result = apiInstance.collectionVersionDetails(collectionId, versionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionVersionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier
$versionId = 789; // Long | Version Number

try {
    $result = $api_instance->collectionVersionDetails($collectionId, $versionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionVersionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier
my $versionId = 789; # Long | Version Number

eval {
    my $result = $api_instance->collectionVersionDetails(collectionId => $collectionId, versionId => $versionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionVersionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)
versionId = 789 # Long | Version Number (default to null)

try:
    # Collection Version details
    api_response = api_instance.collection_version_details(collectionId, versionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionVersionDetails: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let versionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionVersionDetails(collectionId, versionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required
version_id*
Long (int64)
Version Number
Required

Responses


collectionVersions

Collection Versions list

Returns a list of public collection Versions


/collections/{collection_id}/versions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/collections/{collection_id}/versions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            array[CollectionVersions] result = apiInstance.collectionVersions(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionVersions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.collectionVersions(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionVersions: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            array[CollectionVersions] result = apiInstance.collectionVersions(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionVersions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Collection Versions list
[apiInstance collectionVersionsWith:collectionId
              completionHandler: ^(array[CollectionVersions] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionVersions(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionVersionsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Collection Versions list
                array[CollectionVersions] result = apiInstance.collectionVersions(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionVersions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->collectionVersions($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->collectionVersions(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionVersions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Collection Versions list
    api_response = api_instance.collection_versions(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionVersions: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionVersions(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


collectionsList

Public Collections

Returns a list of public collections


/collections

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/collections?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example&institution=789&published_since=publishedSince_example&modified_since=modifiedSince_example&group=789&resource_doi=resourceDoi_example&doi=doi_example&handle=handle_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return collections from this institution
        String publishedSince = publishedSince_example; // String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
        String modifiedSince = modifiedSince_example; // String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
        Long group = 789; // Long | only return collections from this group
        String resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
        String doi = doi_example; // String | only return collections with this doi
        String handle = handle_example; // String | only return collections with this handle

        try {
            array[Collection] result = apiInstance.collectionsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, doi, handle);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order. Default varies by endpoint/resource.
final String orderDirection = new String(); // String | 
final Long institution = new Long(); // Long | only return collections from this institution
final String publishedSince = new String(); // String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
final String modifiedSince = new String(); // String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
final Long group = new Long(); // Long | only return collections from this group
final String resourceDoi = new String(); // String | only return collections with this resource_doi
final String doi = new String(); // String | only return collections with this doi
final String handle = new String(); // String | only return collections with this handle

try {
    final result = await api_instance.collectionsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, doi, handle);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionsList: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return collections from this institution
        String publishedSince = publishedSince_example; // String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
        String modifiedSince = modifiedSince_example; // String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
        Long group = 789; // Long | only return collections from this group
        String resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
        String doi = doi_example; // String | only return collections with this doi
        String handle = handle_example; // String | only return collections with this handle

        try {
            array[Collection] result = apiInstance.collectionsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, doi, handle);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionsList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)
Long *institution = 789; // only return collections from this institution (optional) (default to null)
String *publishedSince = publishedSince_example; // Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
String *modifiedSince = modifiedSince_example; // Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
Long *group = 789; // only return collections from this group (optional) (default to null)
String *resourceDoi = resourceDoi_example; // only return collections with this resource_doi (optional) (default to null)
String *doi = doi_example; // only return collections with this doi (optional) (default to null)
String *handle = handle_example; // only return collections with this handle (optional) (default to null)

// Public Collections
[apiInstance collectionsListWith:xCursor
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
    institution:institution
    publishedSince:publishedSince
    modifiedSince:modifiedSince
    group:group
    resourceDoi:resourceDoi
    doi:doi
    handle:handle
              completionHandler: ^(array[Collection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order. Default varies by endpoint/resource.
  'orderDirection': orderDirection_example, // {String} 
  'institution': 789, // {Long} only return collections from this institution
  'publishedSince': publishedSince_example, // {String} Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
  'modifiedSince': modifiedSince_example, // {String} Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
  'group': 789, // {Long} only return collections from this group
  'resourceDoi': resourceDoi_example, // {String} only return collections with this resource_doi
  'doi': doi_example, // {String} only return collections with this doi
  'handle': handle_example // {String} only return collections with this handle
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionsListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. Default varies by endpoint/resource. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)
            var institution = 789;  // Long | only return collections from this institution (optional)  (default to null)
            var publishedSince = publishedSince_example;  // String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD (optional)  (default to null)
            var modifiedSince = modifiedSince_example;  // String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD (optional)  (default to null)
            var group = 789;  // Long | only return collections from this group (optional)  (default to null)
            var resourceDoi = resourceDoi_example;  // String | only return collections with this resource_doi (optional)  (default to null)
            var doi = doi_example;  // String | only return collections with this doi (optional)  (default to null)
            var handle = handle_example;  // String | only return collections with this handle (optional)  (default to null)

            try {
                // Public Collections
                array[Collection] result = apiInstance.collectionsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, doi, handle);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
$orderDirection = orderDirection_example; // String | 
$institution = 789; // Long | only return collections from this institution
$publishedSince = publishedSince_example; // String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
$modifiedSince = modifiedSince_example; // String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
$group = 789; // Long | only return collections from this group
$resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
$doi = doi_example; // String | only return collections with this doi
$handle = handle_example; // String | only return collections with this handle

try {
    $result = $api_instance->collectionsList($xCursor, $page, $pageSize, $limit, $offset, $order, $orderDirection, $institution, $publishedSince, $modifiedSince, $group, $resourceDoi, $doi, $handle);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order. Default varies by endpoint/resource.
my $orderDirection = orderDirection_example; # String | 
my $institution = 789; # Long | only return collections from this institution
my $publishedSince = publishedSince_example; # String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
my $modifiedSince = modifiedSince_example; # String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
my $group = 789; # Long | only return collections from this group
my $resourceDoi = resourceDoi_example; # String | only return collections with this resource_doi
my $doi = doi_example; # String | only return collections with this doi
my $handle = handle_example; # String | only return collections with this handle

eval {
    my $result = $api_instance->collectionsList(xCursor => $xCursor, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection, institution => $institution, publishedSince => $publishedSince, modifiedSince => $modifiedSince, group => $group, resourceDoi => $resourceDoi, doi => $doi, handle => $handle);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)
institution = 789 # Long | only return collections from this institution (optional) (default to null)
publishedSince = publishedSince_example # String | Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
modifiedSince = modifiedSince_example # String | Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
group = 789 # Long | only return collections from this group (optional) (default to null)
resourceDoi = resourceDoi_example # String | only return collections with this resource_doi (optional) (default to null)
doi = doi_example # String | only return collections with this doi (optional) (default to null)
handle = handle_example # String | only return collections with this handle (optional) (default to null)

try:
    # Public Collections
    api_response = api_instance.collections_list(xCursor=xCursor, page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection, institution=institution, publishedSince=publishedSince, modifiedSince=modifiedSince, group=group, resourceDoi=resourceDoi, doi=doi, handle=handle)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionsList: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String
    let institution = 789; // Long
    let publishedSince = publishedSince_example; // String
    let modifiedSince = modifiedSince_example; // String
    let group = 789; // Long
    let resourceDoi = resourceDoi_example; // String
    let doi = doi_example; // String
    let handle = handle_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, modifiedSince, group, resourceDoi, doi, handle, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order. Default varies by endpoint/resource.
order_direction
String
institution
Long (int64)
only return collections from this institution
published_since
String
Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD
modified_since
String
Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD
group
Long (int64)
only return collections from this group
resource_doi
String
only return collections with this resource_doi
doi
String
only return collections with this doi
handle
String
only return collections with this handle

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.


collectionsSearch

Public Collections Search

Returns a list of public collections


/collections/search

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/collections/search" \
 -d '{
  "resource_doi" : "10.6084/m9.figshare.1407024",
  "handle" : "10084/figshare.1407024",
  "doi" : "10.6084/m9.figshare.1407024",
  "order" : "published_date"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        CollectionSearch search = ; // CollectionSearch | 

        try {
            array[Collection] result = apiInstance.collectionsSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final CollectionSearch search = new CollectionSearch(); // CollectionSearch | 

try {
    final result = await api_instance.collectionsSearch(xCursor, search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->collectionsSearch: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        CollectionSearch search = ; // CollectionSearch | 

        try {
            array[Collection] result = apiInstance.collectionsSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#collectionsSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
CollectionSearch *search = ; //  (optional)

// Public Collections Search
[apiInstance collectionsSearchWith:xCursor
    search:search
              completionHandler: ^(array[Collection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'search':  // {CollectionSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectionsSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class collectionsSearchExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var search = new CollectionSearch(); // CollectionSearch |  (optional) 

            try {
                // Public Collections Search
                array[Collection] result = apiInstance.collectionsSearch(xCursor, search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.collectionsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$search = ; // CollectionSearch | 

try {
    $result = $api_instance->collectionsSearch($xCursor, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->collectionsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $search = WWW::OPenAPIClient::Object::CollectionSearch->new(); # CollectionSearch | 

eval {
    my $result = $api_instance->collectionsSearch(xCursor => $xCursor, search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->collectionsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
search =  # CollectionSearch |  (optional)

try:
    # Public Collections Search
    api_response = api_instance.collections_search(xCursor=xCursor, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->collectionsSearch: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let search = ; // CollectionSearch

    let mut context = CollectionsApi::Context::default();
    let result = client.collectionsSearch(xCursor, search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Body parameters
Name Description
search

Search Parameters

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.


privateCollectionArticleDelete

Delete collection article

De-associate article from collection


/account/collections/{collection_id}/articles/{article_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long articleId = 789; // Long | Collection article unique identifier

        try {
            apiInstance.privateCollectionArticleDelete(collectionId, articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticleDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final Long articleId = new Long(); // Long | Collection article unique identifier

try {
    final result = await api_instance.privateCollectionArticleDelete(collectionId, articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionArticleDelete: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long articleId = 789; // Long | Collection article unique identifier

        try {
            apiInstance.privateCollectionArticleDelete(collectionId, articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticleDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
Long *articleId = 789; // Collection article unique identifier (default to null)

// Delete collection article
[apiInstance privateCollectionArticleDeleteWith:collectionId
    articleId:articleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var articleId = 789; // {Long} Collection article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionArticleDelete(collectionId, articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionArticleDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var articleId = 789;  // Long | Collection article unique identifier (default to null)

            try {
                // Delete collection article
                apiInstance.privateCollectionArticleDelete(collectionId, articleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionArticleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$articleId = 789; // Long | Collection article unique identifier

try {
    $api_instance->privateCollectionArticleDelete($collectionId, $articleId);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionArticleDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $articleId = 789; # Long | Collection article unique identifier

eval {
    $api_instance->privateCollectionArticleDelete(collectionId => $collectionId, articleId => $articleId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionArticleDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
articleId = 789 # Long | Collection article unique identifier (default to null)

try:
    # Delete collection article
    api_instance.private_collection_article_delete(collectionId, articleId)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionArticleDelete: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let articleId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionArticleDelete(collectionId, articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
article_id*
Long (int64)
Collection article unique identifier
Required

Responses


privateCollectionArticlesAdd

Add collection articles

Associate new articles with the collection. This will add new articles to the list of already associated articles


/account/collections/{collection_id}/articles

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/articles" \
 -d '{
  "articles" : [ 2000003, 2000004 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        ArticlesCreator articles = ; // ArticlesCreator | 

        try {
            Location result = apiInstance.privateCollectionArticlesAdd(collectionId, articles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesAdd");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final ArticlesCreator articles = new ArticlesCreator(); // ArticlesCreator | 

try {
    final result = await api_instance.privateCollectionArticlesAdd(collectionId, articles);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionArticlesAdd: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        ArticlesCreator articles = ; // ArticlesCreator | 

        try {
            Location result = apiInstance.privateCollectionArticlesAdd(collectionId, articles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesAdd");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
ArticlesCreator *articles = ; // 

// Add collection articles
[apiInstance privateCollectionArticlesAddWith:collectionId
    articles:articles
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var articles = ; // {ArticlesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionArticlesAdd(collectionId, articles, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionArticlesAddExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var articles = new ArticlesCreator(); // ArticlesCreator | 

            try {
                // Add collection articles
                Location result = apiInstance.privateCollectionArticlesAdd(collectionId, articles);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionArticlesAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$articles = ; // ArticlesCreator | 

try {
    $result = $api_instance->privateCollectionArticlesAdd($collectionId, $articles);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionArticlesAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $articles = WWW::OPenAPIClient::Object::ArticlesCreator->new(); # ArticlesCreator | 

eval {
    my $result = $api_instance->privateCollectionArticlesAdd(collectionId => $collectionId, articles => $articles);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionArticlesAdd: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
articles =  # ArticlesCreator | 

try:
    # Add collection articles
    api_response = api_instance.private_collection_articles_add(collectionId, articles)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionArticlesAdd: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let articles = ; // ArticlesCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionArticlesAdd(collectionId, articles, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
articles *

Articles list

Responses

Name Type Format Description
Location String url Location of article


privateCollectionArticlesList

List collection articles

List collection articles


/account/collections/{collection_id}/articles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/articles?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.privateCollectionArticlesList(collectionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.privateCollectionArticlesList(collectionId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionArticlesList: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.privateCollectionArticlesList(collectionId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// List collection articles
[apiInstance privateCollectionArticlesListWith:collectionId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionArticlesList(collectionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionArticlesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // List collection articles
                array[Article] result = apiInstance.privateCollectionArticlesList(collectionId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionArticlesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->privateCollectionArticlesList($collectionId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionArticlesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->privateCollectionArticlesList(collectionId => $collectionId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionArticlesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # List collection articles
    api_response = api_instance.private_collection_articles_list(collectionId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionArticlesList: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionArticlesList(collectionId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


privateCollectionArticlesReplace

Replace collection articles

Associate new articles with the collection. This will remove all already associated articles and add these new ones


/account/collections/{collection_id}/articles

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/articles" \
 -d '{
  "articles" : [ 2000003, 2000004 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        ArticlesCreator articles = ; // ArticlesCreator | 

        try {
            apiInstance.privateCollectionArticlesReplace(collectionId, articles);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final ArticlesCreator articles = new ArticlesCreator(); // ArticlesCreator | 

try {
    final result = await api_instance.privateCollectionArticlesReplace(collectionId, articles);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionArticlesReplace: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        ArticlesCreator articles = ; // ArticlesCreator | 

        try {
            apiInstance.privateCollectionArticlesReplace(collectionId, articles);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionArticlesReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
ArticlesCreator *articles = ; // 

// Replace collection articles
[apiInstance privateCollectionArticlesReplaceWith:collectionId
    articles:articles
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var articles = ; // {ArticlesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionArticlesReplace(collectionId, articles, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionArticlesReplaceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var articles = new ArticlesCreator(); // ArticlesCreator | 

            try {
                // Replace collection articles
                apiInstance.privateCollectionArticlesReplace(collectionId, articles);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionArticlesReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$articles = ; // ArticlesCreator | 

try {
    $api_instance->privateCollectionArticlesReplace($collectionId, $articles);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionArticlesReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $articles = WWW::OPenAPIClient::Object::ArticlesCreator->new(); # ArticlesCreator | 

eval {
    $api_instance->privateCollectionArticlesReplace(collectionId => $collectionId, articles => $articles);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionArticlesReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
articles =  # ArticlesCreator | 

try:
    # Replace collection articles
    api_instance.private_collection_articles_replace(collectionId, articles)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionArticlesReplace: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let articles = ; // ArticlesCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionArticlesReplace(collectionId, articles, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
articles *

Articles List

Responses

Name Type Format Description
Location String url Location of article


privateCollectionAuthorDelete

Delete collection author

Delete collection author


/account/collections/{collection_id}/authors/{author_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/authors/{author_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long authorId = 789; // Long | Collection Author unique identifier

        try {
            apiInstance.privateCollectionAuthorDelete(collectionId, authorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final Long authorId = new Long(); // Long | Collection Author unique identifier

try {
    final result = await api_instance.privateCollectionAuthorDelete(collectionId, authorId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionAuthorDelete: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long authorId = 789; // Long | Collection Author unique identifier

        try {
            apiInstance.privateCollectionAuthorDelete(collectionId, authorId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
Long *authorId = 789; // Collection Author unique identifier (default to null)

// Delete collection author
[apiInstance privateCollectionAuthorDeleteWith:collectionId
    authorId:authorId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var authorId = 789; // {Long} Collection Author unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionAuthorDelete(collectionId, authorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionAuthorDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var authorId = 789;  // Long | Collection Author unique identifier (default to null)

            try {
                // Delete collection author
                apiInstance.privateCollectionAuthorDelete(collectionId, authorId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionAuthorDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$authorId = 789; // Long | Collection Author unique identifier

try {
    $api_instance->privateCollectionAuthorDelete($collectionId, $authorId);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionAuthorDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $authorId = 789; # Long | Collection Author unique identifier

eval {
    $api_instance->privateCollectionAuthorDelete(collectionId => $collectionId, authorId => $authorId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionAuthorDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
authorId = 789 # Long | Collection Author unique identifier (default to null)

try:
    # Delete collection author
    api_instance.private_collection_author_delete(collectionId, authorId)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionAuthorDelete: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let authorId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionAuthorDelete(collectionId, authorId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
author_id*
Long (int64)
Collection Author unique identifier
Required

Responses


privateCollectionAuthorsAdd

Add collection authors

Associate new authors with the collection. This will add new authors to the list of already associated authors


/account/collections/{collection_id}/authors

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/authors" \
 -d '{
  "authors" : [ {
    "id" : 12121
  }, {
    "id" : 34345
  }, {
    "name" : "John Doe"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            Location result = apiInstance.privateCollectionAuthorsAdd(collectionId, authors);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsAdd");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final AuthorsCreator authors = new AuthorsCreator(); // AuthorsCreator | 

try {
    final result = await api_instance.privateCollectionAuthorsAdd(collectionId, authors);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionAuthorsAdd: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            Location result = apiInstance.privateCollectionAuthorsAdd(collectionId, authors);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsAdd");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
AuthorsCreator *authors = ; // 

// Add collection authors
[apiInstance privateCollectionAuthorsAddWith:collectionId
    authors:authors
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var authors = ; // {AuthorsCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionAuthorsAdd(collectionId, authors, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionAuthorsAddExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var authors = new AuthorsCreator(); // AuthorsCreator | 

            try {
                // Add collection authors
                Location result = apiInstance.privateCollectionAuthorsAdd(collectionId, authors);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionAuthorsAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$authors = ; // AuthorsCreator | 

try {
    $result = $api_instance->privateCollectionAuthorsAdd($collectionId, $authors);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionAuthorsAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $authors = WWW::OPenAPIClient::Object::AuthorsCreator->new(); # AuthorsCreator | 

eval {
    my $result = $api_instance->privateCollectionAuthorsAdd(collectionId => $collectionId, authors => $authors);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionAuthorsAdd: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
authors =  # AuthorsCreator | 

try:
    # Add collection authors
    api_response = api_instance.private_collection_authors_add(collectionId, authors)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionAuthorsAdd: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let authors = ; // AuthorsCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionAuthorsAdd(collectionId, authors, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
authors *

List of authors

Responses

Name Type Format Description
Location String url Location of article


privateCollectionAuthorsList

List collection authors

List collection authors


/account/collections/{collection_id}/authors

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/authors"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier

        try {
            array[Author] result = apiInstance.privateCollectionAuthorsList(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier

try {
    final result = await api_instance.privateCollectionAuthorsList(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionAuthorsList: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier

        try {
            array[Author] result = apiInstance.privateCollectionAuthorsList(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)

// List collection authors
[apiInstance privateCollectionAuthorsListWith:collectionId
              completionHandler: ^(array[Author] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionAuthorsList(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionAuthorsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)

            try {
                // List collection authors
                array[Author] result = apiInstance.privateCollectionAuthorsList(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionAuthorsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier

try {
    $result = $api_instance->privateCollectionAuthorsList($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionAuthorsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier

eval {
    my $result = $api_instance->privateCollectionAuthorsList(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionAuthorsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)

try:
    # List collection authors
    api_response = api_instance.private_collection_authors_list(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionAuthorsList: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionAuthorsList(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required

Responses


privateCollectionAuthorsReplace

Replace collection authors

Associate new authors with the collection. This will remove all already associated authors and add these new ones


/account/collections/{collection_id}/authors

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/authors" \
 -d '{
  "authors" : [ {
    "id" : 12121
  }, {
    "id" : 34345
  }, {
    "name" : "John Doe"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateCollectionAuthorsReplace(collectionId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final AuthorsCreator authors = new AuthorsCreator(); // AuthorsCreator | 

try {
    final result = await api_instance.privateCollectionAuthorsReplace(collectionId, authors);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionAuthorsReplace: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        AuthorsCreator authors = ; // AuthorsCreator | 

        try {
            apiInstance.privateCollectionAuthorsReplace(collectionId, authors);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionAuthorsReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
AuthorsCreator *authors = ; // 

// Replace collection authors
[apiInstance privateCollectionAuthorsReplaceWith:collectionId
    authors:authors
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var authors = ; // {AuthorsCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionAuthorsReplace(collectionId, authors, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionAuthorsReplaceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var authors = new AuthorsCreator(); // AuthorsCreator | 

            try {
                // Replace collection authors
                apiInstance.privateCollectionAuthorsReplace(collectionId, authors);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionAuthorsReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$authors = ; // AuthorsCreator | 

try {
    $api_instance->privateCollectionAuthorsReplace($collectionId, $authors);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionAuthorsReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $authors = WWW::OPenAPIClient::Object::AuthorsCreator->new(); # AuthorsCreator | 

eval {
    $api_instance->privateCollectionAuthorsReplace(collectionId => $collectionId, authors => $authors);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionAuthorsReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
authors =  # AuthorsCreator | 

try:
    # Replace collection authors
    api_instance.private_collection_authors_replace(collectionId, authors)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionAuthorsReplace: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let authors = ; // AuthorsCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionAuthorsReplace(collectionId, authors, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
authors *

List of authors

Responses

Name Type Format Description
Location String url Location of article


privateCollectionCategoriesAdd

Add collection categories

Associate new categories with the collection. This will add new categories to the list of already associated categories


/account/collections/{collection_id}/categories

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/categories" \
 -d '{
  "categories" : [ 1, 10, 11 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            Location result = apiInstance.privateCollectionCategoriesAdd(collectionId, categories);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesAdd");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final CategoriesCreator categories = new CategoriesCreator(); // CategoriesCreator | 

try {
    final result = await api_instance.privateCollectionCategoriesAdd(collectionId, categories);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionCategoriesAdd: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            Location result = apiInstance.privateCollectionCategoriesAdd(collectionId, categories);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesAdd");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
CategoriesCreator *categories = ; // 

// Add collection categories
[apiInstance privateCollectionCategoriesAddWith:collectionId
    categories:categories
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var categories = ; // {CategoriesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionCategoriesAdd(collectionId, categories, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionCategoriesAddExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var categories = new CategoriesCreator(); // CategoriesCreator | 

            try {
                // Add collection categories
                Location result = apiInstance.privateCollectionCategoriesAdd(collectionId, categories);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionCategoriesAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$categories = ; // CategoriesCreator | 

try {
    $result = $api_instance->privateCollectionCategoriesAdd($collectionId, $categories);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionCategoriesAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $categories = WWW::OPenAPIClient::Object::CategoriesCreator->new(); # CategoriesCreator | 

eval {
    my $result = $api_instance->privateCollectionCategoriesAdd(collectionId => $collectionId, categories => $categories);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionCategoriesAdd: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
categories =  # CategoriesCreator | 

try:
    # Add collection categories
    api_response = api_instance.private_collection_categories_add(collectionId, categories)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionCategoriesAdd: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let categories = ; // CategoriesCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionCategoriesAdd(collectionId, categories, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
categories *

Categories list

Responses

Name Type Format Description
Location String url Location of article


privateCollectionCategoriesList

List collection categories

List collection categories


/account/collections/{collection_id}/categories

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/categories"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier

        try {
            array[Category] result = apiInstance.privateCollectionCategoriesList(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier

try {
    final result = await api_instance.privateCollectionCategoriesList(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionCategoriesList: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier

        try {
            array[Category] result = apiInstance.privateCollectionCategoriesList(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)

// List collection categories
[apiInstance privateCollectionCategoriesListWith:collectionId
              completionHandler: ^(array[Category] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionCategoriesList(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionCategoriesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)

            try {
                // List collection categories
                array[Category] result = apiInstance.privateCollectionCategoriesList(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionCategoriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier

try {
    $result = $api_instance->privateCollectionCategoriesList($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionCategoriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier

eval {
    my $result = $api_instance->privateCollectionCategoriesList(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionCategoriesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)

try:
    # List collection categories
    api_response = api_instance.private_collection_categories_list(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionCategoriesList: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionCategoriesList(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required

Responses


privateCollectionCategoriesReplace

Replace collection categories

Associate new categories with the collection. This will remove all already associated categories and add these new ones


/account/collections/{collection_id}/categories

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/categories" \
 -d '{
  "categories" : [ 1, 10, 11 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateCollectionCategoriesReplace(collectionId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesReplace");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final CategoriesCreator categories = new CategoriesCreator(); // CategoriesCreator | 

try {
    final result = await api_instance.privateCollectionCategoriesReplace(collectionId, categories);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionCategoriesReplace: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CategoriesCreator categories = ; // CategoriesCreator | 

        try {
            apiInstance.privateCollectionCategoriesReplace(collectionId, categories);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoriesReplace");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
CategoriesCreator *categories = ; // 

// Replace collection categories
[apiInstance privateCollectionCategoriesReplaceWith:collectionId
    categories:categories
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var categories = ; // {CategoriesCreator} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionCategoriesReplace(collectionId, categories, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionCategoriesReplaceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var categories = new CategoriesCreator(); // CategoriesCreator | 

            try {
                // Replace collection categories
                apiInstance.privateCollectionCategoriesReplace(collectionId, categories);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionCategoriesReplace: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$categories = ; // CategoriesCreator | 

try {
    $api_instance->privateCollectionCategoriesReplace($collectionId, $categories);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionCategoriesReplace: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $categories = WWW::OPenAPIClient::Object::CategoriesCreator->new(); # CategoriesCreator | 

eval {
    $api_instance->privateCollectionCategoriesReplace(collectionId => $collectionId, categories => $categories);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionCategoriesReplace: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
categories =  # CategoriesCreator | 

try:
    # Replace collection categories
    api_instance.private_collection_categories_replace(collectionId, categories)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionCategoriesReplace: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let categories = ; // CategoriesCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionCategoriesReplace(collectionId, categories, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
categories *

Categories list

Responses

Name Type Format Description
Location String url Location of article


privateCollectionCategoryDelete

Delete collection category

De-associate category from collection


/account/collections/{collection_id}/categories/{category_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/categories/{category_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long categoryId = 789; // Long | Collection category unique identifier

        try {
            apiInstance.privateCollectionCategoryDelete(collectionId, categoryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoryDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final Long categoryId = new Long(); // Long | Collection category unique identifier

try {
    final result = await api_instance.privateCollectionCategoryDelete(collectionId, categoryId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionCategoryDelete: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Long categoryId = 789; // Long | Collection category unique identifier

        try {
            apiInstance.privateCollectionCategoryDelete(collectionId, categoryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCategoryDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
Long *categoryId = 789; // Collection category unique identifier (default to null)

// Delete collection category
[apiInstance privateCollectionCategoryDeleteWith:collectionId
    categoryId:categoryId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var categoryId = 789; // {Long} Collection category unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionCategoryDelete(collectionId, categoryId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionCategoryDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var categoryId = 789;  // Long | Collection category unique identifier (default to null)

            try {
                // Delete collection category
                apiInstance.privateCollectionCategoryDelete(collectionId, categoryId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionCategoryDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$categoryId = 789; // Long | Collection category unique identifier

try {
    $api_instance->privateCollectionCategoryDelete($collectionId, $categoryId);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionCategoryDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $categoryId = 789; # Long | Collection category unique identifier

eval {
    $api_instance->privateCollectionCategoryDelete(collectionId => $collectionId, categoryId => $categoryId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionCategoryDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
categoryId = 789 # Long | Collection category unique identifier (default to null)

try:
    # Delete collection category
    api_instance.private_collection_category_delete(collectionId, categoryId)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionCategoryDelete: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let categoryId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionCategoryDelete(collectionId, categoryId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
category_id*
Long (int64)
Collection category unique identifier
Required

Responses


privateCollectionCreate

Create collection

Create a new Collection by sending collection information


/account/collections

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of article",
  "handle" : "",
  "title" : "Test collection title",
  "resource_version" : 0,
  "tags" : [ "tag1", "tag2" ],
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "resource_link" : "resource_link",
  "group_id" : 6,
  "resource_doi" : "",
  "resource_title" : "",
  "resource_id" : "resource_id",
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "categories" : [ 1, 10, 11 ],
  "articles" : [ 2000001, 2000005 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 20005
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        CollectionCreate collection = ; // CollectionCreate | 

        try {
            LocationWarnings result = apiInstance.privateCollectionCreate(collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CollectionCreate collection = new CollectionCreate(); // CollectionCreate | 

try {
    final result = await api_instance.privateCollectionCreate(collection);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionCreate: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        CollectionCreate collection = ; // CollectionCreate | 

        try {
            LocationWarnings result = apiInstance.privateCollectionCreate(collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
CollectionCreate *collection = ; // 

// Create collection
[apiInstance privateCollectionCreateWith:collection
              completionHandler: ^(LocationWarnings output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collection = ; // {CollectionCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionCreate(collection, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collection = new CollectionCreate(); // CollectionCreate | 

            try {
                // Create collection
                LocationWarnings result = apiInstance.privateCollectionCreate(collection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collection = ; // CollectionCreate | 

try {
    $result = $api_instance->privateCollectionCreate($collection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collection = WWW::OPenAPIClient::Object::CollectionCreate->new(); # CollectionCreate | 

eval {
    my $result = $api_instance->privateCollectionCreate(collection => $collection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collection =  # CollectionCreate | 

try:
    # Create collection
    api_response = api_instance.private_collection_create(collection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionCreate: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collection = ; // CollectionCreate

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionCreate(collection, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
collection *

Collection description

Responses


privateCollectionDelete

Delete collection

Delete n collection


/account/collections/{collection_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            apiInstance.privateCollectionDelete(collectionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.privateCollectionDelete(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionDelete: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            apiInstance.privateCollectionDelete(collectionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Delete collection
[apiInstance privateCollectionDeleteWith:collectionId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionDelete(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Delete collection
                apiInstance.privateCollectionDelete(collectionId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $api_instance->privateCollectionDelete($collectionId);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    $api_instance->privateCollectionDelete(collectionId => $collectionId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Delete collection
    api_instance.private_collection_delete(collectionId)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionDelete: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionDelete(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


privateCollectionDetails

Collection details

View a collection


/account/collections/{collection_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionCompletePrivate result = apiInstance.privateCollectionDetails(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.privateCollectionDetails(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionDetails: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionCompletePrivate result = apiInstance.privateCollectionDetails(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Collection details
[apiInstance privateCollectionDetailsWith:collectionId
              completionHandler: ^(CollectionCompletePrivate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionDetails(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Collection details
                CollectionCompletePrivate result = apiInstance.privateCollectionDetails(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->privateCollectionDetails($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->privateCollectionDetails(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Collection details
    api_response = api_instance.private_collection_details(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionDetails: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionDetails(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


privateCollectionPatch

Partially update collection

Partially update a collection by sending only the fields to change.


/account/collections/{collection_id}

Usage and SDK Samples

curl -X PATCH \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of collection",
  "handle" : "",
  "title" : "Test collection title",
  "resource_version" : 0,
  "tags" : [ "tag1", "tag2" ],
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "resource_link" : "resource_link",
  "group_id" : 6,
  "resource_doi" : "",
  "resource_title" : "",
  "resource_id" : "resource_id",
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "categories" : [ 1, 10, 11 ],
  "articles" : [ 2000001, 2000005 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 20005
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        CollectionUpdate collection = ; // CollectionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateCollectionPatch(collectionId, collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPatch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier
final CollectionUpdate collection = new CollectionUpdate(); // CollectionUpdate | 

try {
    final result = await api_instance.privateCollectionPatch(collectionId, collection);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPatch: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        CollectionUpdate collection = ; // CollectionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateCollectionPatch(collectionId, collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)
CollectionUpdate *collection = ; // 

// Partially update collection
[apiInstance privateCollectionPatchWith:collectionId
    collection:collection
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier
var collection = ; // {CollectionUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionPatch(collectionId, collection, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPatchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)
            var collection = new CollectionUpdate(); // CollectionUpdate | 

            try {
                // Partially update collection
                LocationWarningsUpdate result = apiInstance.privateCollectionPatch(collectionId, collection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier
$collection = ; // CollectionUpdate | 

try {
    $result = $api_instance->privateCollectionPatch($collectionId, $collection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier
my $collection = WWW::OPenAPIClient::Object::CollectionUpdate->new(); # CollectionUpdate | 

eval {
    my $result = $api_instance->privateCollectionPatch(collectionId => $collectionId, collection => $collection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPatch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)
collection =  # CollectionUpdate | 

try:
    # Partially update collection
    api_response = api_instance.private_collection_patch(collectionId, collection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPatch: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let collection = ; // CollectionUpdate

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPatch(collectionId, collection, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required
Body parameters
Name Description
collection *

Subset of collection fields to update

Responses

Name Type Format Description
Location String link Location of project


privateCollectionPrivateLinkCreate

Create collection private link

Create new private link


/account/collections/{collection_id}/private_links

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/private_links" \
 -d '{
  "expires_date" : "2018-02-22 22:22:22"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CollectionPrivateLinkCreator privateLink = ; // CollectionPrivateLinkCreator | 

        try {
            PrivateLinkResponse result = apiInstance.privateCollectionPrivateLinkCreate(collectionId, privateLink);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final CollectionPrivateLinkCreator privateLink = new CollectionPrivateLinkCreator(); // CollectionPrivateLinkCreator | 

try {
    final result = await api_instance.privateCollectionPrivateLinkCreate(collectionId, privateLink);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPrivateLinkCreate: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        CollectionPrivateLinkCreator privateLink = ; // CollectionPrivateLinkCreator | 

        try {
            PrivateLinkResponse result = apiInstance.privateCollectionPrivateLinkCreate(collectionId, privateLink);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
CollectionPrivateLinkCreator *privateLink = ; //  (optional)

// Create collection private link
[apiInstance privateCollectionPrivateLinkCreateWith:collectionId
    privateLink:privateLink
              completionHandler: ^(PrivateLinkResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var opts = {
  'privateLink':  // {CollectionPrivateLinkCreator} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionPrivateLinkCreate(collectionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPrivateLinkCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var privateLink = new CollectionPrivateLinkCreator(); // CollectionPrivateLinkCreator |  (optional) 

            try {
                // Create collection private link
                PrivateLinkResponse result = apiInstance.privateCollectionPrivateLinkCreate(collectionId, privateLink);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPrivateLinkCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$privateLink = ; // CollectionPrivateLinkCreator | 

try {
    $result = $api_instance->privateCollectionPrivateLinkCreate($collectionId, $privateLink);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPrivateLinkCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $privateLink = WWW::OPenAPIClient::Object::CollectionPrivateLinkCreator->new(); # CollectionPrivateLinkCreator | 

eval {
    my $result = $api_instance->privateCollectionPrivateLinkCreate(collectionId => $collectionId, privateLink => $privateLink);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPrivateLinkCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
privateLink =  # CollectionPrivateLinkCreator |  (optional)

try:
    # Create collection private link
    api_response = api_instance.private_collection_private_link_create(collectionId, privateLink=privateLink)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPrivateLinkCreate: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let privateLink = ; // CollectionPrivateLinkCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPrivateLinkCreate(collectionId, privateLink, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
privateLink

Responses

Name Type Format Description
Location String url Location of article


privateCollectionPrivateLinkDelete

Disable private link

Disable/delete private link for this collection


/account/collections/{collection_id}/private_links/{link_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/private_links/{link_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            apiInstance.privateCollectionPrivateLinkDelete(collectionId, linkId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final String linkId = new String(); // String | Private link token

try {
    final result = await api_instance.privateCollectionPrivateLinkDelete(collectionId, linkId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPrivateLinkDelete: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            apiInstance.privateCollectionPrivateLinkDelete(collectionId, linkId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
String *linkId = linkId_example; // Private link token (default to null)

// Disable private link
[apiInstance privateCollectionPrivateLinkDeleteWith:collectionId
    linkId:linkId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var linkId = linkId_example; // {String} Private link token

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionPrivateLinkDelete(collectionId, linkId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPrivateLinkDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var linkId = linkId_example;  // String | Private link token (default to null)

            try {
                // Disable private link
                apiInstance.privateCollectionPrivateLinkDelete(collectionId, linkId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPrivateLinkDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$linkId = linkId_example; // String | Private link token

try {
    $api_instance->privateCollectionPrivateLinkDelete($collectionId, $linkId);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPrivateLinkDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $linkId = linkId_example; # String | Private link token

eval {
    $api_instance->privateCollectionPrivateLinkDelete(collectionId => $collectionId, linkId => $linkId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPrivateLinkDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
linkId = linkId_example # String | Private link token (default to null)

try:
    # Disable private link
    api_instance.private_collection_private_link_delete(collectionId, linkId)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPrivateLinkDelete: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let linkId = linkId_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPrivateLinkDelete(collectionId, linkId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
link_id*
String
Private link token
Required

Responses


privateCollectionPrivateLinkDetails

View collection private link

View existing private link for this collection


/account/collections/{collection_id}/private_links/{link_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/private_links/{link_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            PrivateLink result = apiInstance.privateCollectionPrivateLinkDetails(collectionId, linkId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final String linkId = new String(); // String | Private link token

try {
    final result = await api_instance.privateCollectionPrivateLinkDetails(collectionId, linkId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPrivateLinkDetails: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token

        try {
            PrivateLink result = apiInstance.privateCollectionPrivateLinkDetails(collectionId, linkId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
String *linkId = linkId_example; // Private link token (default to null)

// View collection private link
[apiInstance privateCollectionPrivateLinkDetailsWith:collectionId
    linkId:linkId
              completionHandler: ^(PrivateLink output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var linkId = linkId_example; // {String} Private link token

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionPrivateLinkDetails(collectionId, linkId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPrivateLinkDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var linkId = linkId_example;  // String | Private link token (default to null)

            try {
                // View collection private link
                PrivateLink result = apiInstance.privateCollectionPrivateLinkDetails(collectionId, linkId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPrivateLinkDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$linkId = linkId_example; // String | Private link token

try {
    $result = $api_instance->privateCollectionPrivateLinkDetails($collectionId, $linkId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPrivateLinkDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $linkId = linkId_example; # String | Private link token

eval {
    my $result = $api_instance->privateCollectionPrivateLinkDetails(collectionId => $collectionId, linkId => $linkId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPrivateLinkDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
linkId = linkId_example # String | Private link token (default to null)

try:
    # View collection private link
    api_response = api_instance.private_collection_private_link_details(collectionId, linkId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPrivateLinkDetails: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let linkId = linkId_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPrivateLinkDetails(collectionId, linkId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
link_id*
String
Private link token
Required

Responses


privateCollectionPrivateLinkUpdate

Update collection private link

Update existing private link for this collection


/account/collections/{collection_id}/private_links/{link_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/private_links/{link_id}" \
 -d '{
  "expires_date" : "2018-02-22 22:22:22"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token
        CollectionPrivateLinkCreator privateLink = ; // CollectionPrivateLinkCreator | 

        try {
            apiInstance.privateCollectionPrivateLinkUpdate(collectionId, linkId, privateLink);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final String linkId = new String(); // String | Private link token
final CollectionPrivateLinkCreator privateLink = new CollectionPrivateLinkCreator(); // CollectionPrivateLinkCreator | 

try {
    final result = await api_instance.privateCollectionPrivateLinkUpdate(collectionId, linkId, privateLink);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPrivateLinkUpdate: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        String linkId = linkId_example; // String | Private link token
        CollectionPrivateLinkCreator privateLink = ; // CollectionPrivateLinkCreator | 

        try {
            apiInstance.privateCollectionPrivateLinkUpdate(collectionId, linkId, privateLink);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPrivateLinkUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
String *linkId = linkId_example; // Private link token (default to null)
CollectionPrivateLinkCreator *privateLink = ; //  (optional)

// Update collection private link
[apiInstance privateCollectionPrivateLinkUpdateWith:collectionId
    linkId:linkId
    privateLink:privateLink
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var linkId = linkId_example; // {String} Private link token
var opts = {
  'privateLink':  // {CollectionPrivateLinkCreator} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateCollectionPrivateLinkUpdate(collectionId, linkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPrivateLinkUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var linkId = linkId_example;  // String | Private link token (default to null)
            var privateLink = new CollectionPrivateLinkCreator(); // CollectionPrivateLinkCreator |  (optional) 

            try {
                // Update collection private link
                apiInstance.privateCollectionPrivateLinkUpdate(collectionId, linkId, privateLink);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPrivateLinkUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$linkId = linkId_example; // String | Private link token
$privateLink = ; // CollectionPrivateLinkCreator | 

try {
    $api_instance->privateCollectionPrivateLinkUpdate($collectionId, $linkId, $privateLink);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPrivateLinkUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $linkId = linkId_example; # String | Private link token
my $privateLink = WWW::OPenAPIClient::Object::CollectionPrivateLinkCreator->new(); # CollectionPrivateLinkCreator | 

eval {
    $api_instance->privateCollectionPrivateLinkUpdate(collectionId => $collectionId, linkId => $linkId, privateLink => $privateLink);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPrivateLinkUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
linkId = linkId_example # String | Private link token (default to null)
privateLink =  # CollectionPrivateLinkCreator |  (optional)

try:
    # Update collection private link
    api_instance.private_collection_private_link_update(collectionId, linkId, privateLink=privateLink)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPrivateLinkUpdate: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let linkId = linkId_example; // String
    let privateLink = ; // CollectionPrivateLinkCreator

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPrivateLinkUpdate(collectionId, linkId, privateLink, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
link_id*
String
Private link token
Required
Body parameters
Name Description
privateLink

Responses

Name Type Format Description
Location String url Location of article



privateCollectionPublish

Private Collection Publish

When a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In order to make these changes publicly visible, an explicit publish operation is needed.


/account/collections/{collection_id}/publish

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/publish"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            Location result = apiInstance.privateCollectionPublish(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPublish");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.privateCollectionPublish(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionPublish: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            Location result = apiInstance.privateCollectionPublish(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionPublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Private Collection Publish
[apiInstance privateCollectionPublishWith:collectionId
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionPublish(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionPublishExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Private Collection Publish
                Location result = apiInstance.privateCollectionPublish(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->privateCollectionPublish($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->privateCollectionPublish(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionPublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Private Collection Publish
    api_response = api_instance.private_collection_publish(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionPublish: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionPublish(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses

Name Type Format Description
Location String link Location of project


privateCollectionReserveDoi

Private Collection Reserve DOI

Reserve DOI for collection


/account/collections/{collection_id}/reserve_doi

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/reserve_doi"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionDOI result = apiInstance.privateCollectionReserveDoi(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionReserveDoi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.privateCollectionReserveDoi(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionReserveDoi: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionDOI result = apiInstance.privateCollectionReserveDoi(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionReserveDoi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Private Collection Reserve DOI
[apiInstance privateCollectionReserveDoiWith:collectionId
              completionHandler: ^(CollectionDOI output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionReserveDoi(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionReserveDoiExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Private Collection Reserve DOI
                CollectionDOI result = apiInstance.privateCollectionReserveDoi(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionReserveDoi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->privateCollectionReserveDoi($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionReserveDoi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->privateCollectionReserveDoi(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionReserveDoi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Private Collection Reserve DOI
    api_response = api_instance.private_collection_reserve_doi(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionReserveDoi: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionReserveDoi(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


privateCollectionReserveHandle

Private Collection Reserve Handle

Reserve Handle for collection


/account/collections/{collection_id}/reserve_handle

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/reserve_handle"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionHandle result = apiInstance.privateCollectionReserveHandle(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionReserveHandle");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier

try {
    final result = await api_instance.privateCollectionReserveHandle(collectionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionReserveHandle: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier

        try {
            CollectionHandle result = apiInstance.privateCollectionReserveHandle(collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionReserveHandle");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)

// Private Collection Reserve Handle
[apiInstance privateCollectionReserveHandleWith:collectionId
              completionHandler: ^(CollectionHandle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionReserveHandle(collectionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionReserveHandleExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)

            try {
                // Private Collection Reserve Handle
                CollectionHandle result = apiInstance.privateCollectionReserveHandle(collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionReserveHandle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier

try {
    $result = $api_instance->privateCollectionReserveHandle($collectionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionReserveHandle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier

eval {
    my $result = $api_instance->privateCollectionReserveHandle(collectionId => $collectionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionReserveHandle: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)

try:
    # Private Collection Reserve Handle
    api_response = api_instance.private_collection_reserve_handle(collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionReserveHandle: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionReserveHandle(collectionId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required

Responses


privateCollectionResource

Private Collection Resource

Edit collection resource data.


/account/collections/{collection_id}/resource

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}/resource" \
 -d '{
  "link" : "https://docs.figshare.com",
  "id" : "aaaa23512",
  "title" : "Test title",
  "version" : 1,
  "doi" : "",
  "status" : "frozen"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Resource resource = ; // Resource | 

        try {
            Location result = apiInstance.privateCollectionResource(collectionId, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionResource");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection unique identifier
final Resource resource = new Resource(); // Resource | 

try {
    final result = await api_instance.privateCollectionResource(collectionId, resource);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionResource: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection unique identifier
        Resource resource = ; // Resource | 

        try {
            Location result = apiInstance.privateCollectionResource(collectionId, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionResource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection unique identifier (default to null)
Resource *resource = ; // 

// Private Collection Resource
[apiInstance privateCollectionResourceWith:collectionId
    resource:resource
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection unique identifier
var resource = ; // {Resource} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionResource(collectionId, resource, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionResourceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection unique identifier (default to null)
            var resource = new Resource(); // Resource | 

            try {
                // Private Collection Resource
                Location result = apiInstance.privateCollectionResource(collectionId, resource);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection unique identifier
$resource = ; // Resource | 

try {
    $result = $api_instance->privateCollectionResource($collectionId, $resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection unique identifier
my $resource = WWW::OPenAPIClient::Object::Resource->new(); # Resource | 

eval {
    my $result = $api_instance->privateCollectionResource(collectionId => $collectionId, resource => $resource);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionResource: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection unique identifier (default to null)
resource =  # Resource | 

try:
    # Private Collection Resource
    api_response = api_instance.private_collection_resource(collectionId, resource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionResource: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let resource = ; // Resource

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionResource(collectionId, resource, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection unique identifier
Required
Body parameters
Name Description
resource *

Resource data

Responses

Name Type Format Description
Location String link Location of project


privateCollectionUpdate

Update collection

Update a collection by passing full body parameters.


/account/collections/{collection_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/{collection_id}" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of collection",
  "handle" : "",
  "title" : "Test collection title",
  "resource_version" : 0,
  "tags" : [ "tag1", "tag2" ],
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "resource_link" : "resource_link",
  "group_id" : 6,
  "resource_doi" : "",
  "resource_title" : "",
  "resource_id" : "resource_id",
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "categories" : [ 1, 10, 11 ],
  "articles" : [ 2000001, 2000005 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 20005
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        CollectionUpdate collection = ; // CollectionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateCollectionUpdate(collectionId, collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long collectionId = new Long(); // Long | Collection Unique identifier
final CollectionUpdate collection = new CollectionUpdate(); // CollectionUpdate | 

try {
    final result = await api_instance.privateCollectionUpdate(collectionId, collection);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionUpdate: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long collectionId = 789; // Long | Collection Unique identifier
        CollectionUpdate collection = ; // CollectionUpdate | 

        try {
            LocationWarningsUpdate result = apiInstance.privateCollectionUpdate(collectionId, collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *collectionId = 789; // Collection Unique identifier (default to null)
CollectionUpdate *collection = ; // 

// Update collection
[apiInstance privateCollectionUpdateWith:collectionId
    collection:collection
              completionHandler: ^(LocationWarningsUpdate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var collectionId = 789; // {Long} Collection Unique identifier
var collection = ; // {CollectionUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionUpdate(collectionId, collection, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var collectionId = 789;  // Long | Collection Unique identifier (default to null)
            var collection = new CollectionUpdate(); // CollectionUpdate | 

            try {
                // Update collection
                LocationWarningsUpdate result = apiInstance.privateCollectionUpdate(collectionId, collection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$collectionId = 789; // Long | Collection Unique identifier
$collection = ; // CollectionUpdate | 

try {
    $result = $api_instance->privateCollectionUpdate($collectionId, $collection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $collectionId = 789; # Long | Collection Unique identifier
my $collection = WWW::OPenAPIClient::Object::CollectionUpdate->new(); # CollectionUpdate | 

eval {
    my $result = $api_instance->privateCollectionUpdate(collectionId => $collectionId, collection => $collection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
collectionId = 789 # Long | Collection Unique identifier (default to null)
collection =  # CollectionUpdate | 

try:
    # Update collection
    api_response = api_instance.private_collection_update(collectionId, collection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionUpdate: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let collectionId = 789; // Long
    let collection = ; // CollectionUpdate

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionUpdate(collectionId, collection, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
collection_id*
Long (int64)
Collection Unique identifier
Required
Body parameters
Name Description
collection *

Collection description

Responses

Name Type Format Description
Location String link Location of project


privateCollectionsList

Private Collections List

List private collections


/account/collections

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/collections?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 

        try {
            array[Collection] result = apiInstance.privateCollectionsList(page, pageSize, limit, offset, order, orderDirection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order. Default varies by endpoint/resource.
final String orderDirection = new String(); // String | 

try {
    final result = await api_instance.privateCollectionsList(page, pageSize, limit, offset, order, orderDirection);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionsList: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 

        try {
            array[Collection] result = apiInstance.privateCollectionsList(page, pageSize, limit, offset, order, orderDirection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)

// Private Collections List
[apiInstance privateCollectionsListWith:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
              completionHandler: ^(array[Collection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order. Default varies by endpoint/resource.
  'orderDirection': orderDirection_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. Default varies by endpoint/resource. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)

            try {
                // Private Collections List
                array[Collection] result = apiInstance.privateCollectionsList(page, pageSize, limit, offset, order, orderDirection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
$orderDirection = orderDirection_example; // String | 

try {
    $result = $api_instance->privateCollectionsList($page, $pageSize, $limit, $offset, $order, $orderDirection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order. Default varies by endpoint/resource.
my $orderDirection = orderDirection_example; # String | 

eval {
    my $result = $api_instance->privateCollectionsList(page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)

try:
    # Private Collections List
    api_response = api_instance.private_collections_list(page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionsList: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionsList(page, pageSize, limit, offset, order, orderDirection, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order. Default varies by endpoint/resource.
order_direction
String

Responses


privateCollectionsSearch

Private Collections Search

Returns a list of private Collections


/account/collections/search

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/collections/search" \
 -d '{
  "resource_id" : "1407024"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

import java.io.File;
import java.util.*;

public class CollectionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        PrivateCollectionSearch search = ; // PrivateCollectionSearch | 

        try {
            array[Collection] result = apiInstance.privateCollectionsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PrivateCollectionSearch search = new PrivateCollectionSearch(); // PrivateCollectionSearch | 

try {
    final result = await api_instance.privateCollectionsSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCollectionsSearch: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        PrivateCollectionSearch search = ; // PrivateCollectionSearch | 

        try {
            array[Collection] result = apiInstance.privateCollectionsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#privateCollectionsSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
PrivateCollectionSearch *search = ; // 

// Private Collections Search
[apiInstance privateCollectionsSearchWith:search
              completionHandler: ^(array[Collection] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.CollectionsApi()
var search = ; // {PrivateCollectionSearch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCollectionsSearch(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCollectionsSearchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var search = new PrivateCollectionSearch(); // PrivateCollectionSearch | 

            try {
                // Private Collections Search
                array[Collection] result = apiInstance.privateCollectionsSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.privateCollectionsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$search = ; // PrivateCollectionSearch | 

try {
    $result = $api_instance->privateCollectionsSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectionsApi->privateCollectionsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $search = WWW::OPenAPIClient::Object::PrivateCollectionSearch->new(); # PrivateCollectionSearch | 

eval {
    my $result = $api_instance->privateCollectionsSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->privateCollectionsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.CollectionsApi()
search =  # PrivateCollectionSearch | 

try:
    # Private Collections Search
    api_response = api_instance.private_collections_search(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->privateCollectionsSearch: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let search = ; // PrivateCollectionSearch

    let mut context = CollectionsApi::Context::default();
    let result = client.privateCollectionsSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
search *

Search Parameters

Responses


Institutions

accountInstitutionCuration

Institution Curation Review

Retrieve a certain curation review by its ID


/account/institution/review/{curation_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/review/{curation_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation

        try {
            CurationDetail result = apiInstance.accountInstitutionCuration(curationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#accountInstitutionCuration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long curationId = new Long(); // Long | ID of the curation

try {
    final result = await api_instance.accountInstitutionCuration(curationId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountInstitutionCuration: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation

        try {
            CurationDetail result = apiInstance.accountInstitutionCuration(curationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#accountInstitutionCuration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *curationId = 789; // ID of the curation (default to null)

// Institution Curation Review
[apiInstance accountInstitutionCurationWith:curationId
              completionHandler: ^(CurationDetail output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var curationId = 789; // {Long} ID of the curation

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountInstitutionCuration(curationId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountInstitutionCurationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var curationId = 789;  // Long | ID of the curation (default to null)

            try {
                // Institution Curation Review
                CurationDetail result = apiInstance.accountInstitutionCuration(curationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.accountInstitutionCuration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$curationId = 789; // Long | ID of the curation

try {
    $result = $api_instance->accountInstitutionCuration($curationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->accountInstitutionCuration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $curationId = 789; # Long | ID of the curation

eval {
    my $result = $api_instance->accountInstitutionCuration(curationId => $curationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->accountInstitutionCuration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
curationId = 789 # Long | ID of the curation (default to null)

try:
    # Institution Curation Review
    api_response = api_instance.account_institution_curation(curationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->accountInstitutionCuration: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let curationId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.accountInstitutionCuration(curationId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
curation_id*
Long (int64)
ID of the curation
Required

Responses


accountInstitutionCurations

Institution Curation Reviews

Retrieve a list of curation reviews for this institution


/account/institution/reviews

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/reviews?group_id=789&article_id=789&status=status_example&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Filter by the group ID
        Long articleId = 789; // Long | Retrieve the reviews for this article
        String status = status_example; // String | Filter by the status of the review
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            Curation result = apiInstance.accountInstitutionCurations(groupId, articleId, status, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#accountInstitutionCurations");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long groupId = new Long(); // Long | Filter by the group ID
final Long articleId = new Long(); // Long | Retrieve the reviews for this article
final String status = new String(); // String | Filter by the status of the review
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.accountInstitutionCurations(groupId, articleId, status, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->accountInstitutionCurations: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Filter by the group ID
        Long articleId = 789; // Long | Retrieve the reviews for this article
        String status = status_example; // String | Filter by the status of the review
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            Curation result = apiInstance.accountInstitutionCurations(groupId, articleId, status, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#accountInstitutionCurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *groupId = 789; // Filter by the group ID (optional) (default to null)
Long *articleId = 789; // Retrieve the reviews for this article (optional) (default to null)
String *status = status_example; // Filter by the status of the review (optional) (default to null)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Institution Curation Reviews
[apiInstance accountInstitutionCurationsWith:groupId
    articleId:articleId
    status:status
    limit:limit
    offset:offset
              completionHandler: ^(Curation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var opts = {
  'groupId': 789, // {Long} Filter by the group ID
  'articleId': 789, // {Long} Retrieve the reviews for this article
  'status': status_example, // {String} Filter by the status of the review
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountInstitutionCurations(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class accountInstitutionCurationsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var groupId = 789;  // Long | Filter by the group ID (optional)  (default to null)
            var articleId = 789;  // Long | Retrieve the reviews for this article (optional)  (default to null)
            var status = status_example;  // String | Filter by the status of the review (optional)  (default to null)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Institution Curation Reviews
                Curation result = apiInstance.accountInstitutionCurations(groupId, articleId, status, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.accountInstitutionCurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$groupId = 789; // Long | Filter by the group ID
$articleId = 789; // Long | Retrieve the reviews for this article
$status = status_example; // String | Filter by the status of the review
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->accountInstitutionCurations($groupId, $articleId, $status, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->accountInstitutionCurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $groupId = 789; # Long | Filter by the group ID
my $articleId = 789; # Long | Retrieve the reviews for this article
my $status = status_example; # String | Filter by the status of the review
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->accountInstitutionCurations(groupId => $groupId, articleId => $articleId, status => $status, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->accountInstitutionCurations: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
groupId = 789 # Long | Filter by the group ID (optional) (default to null)
articleId = 789 # Long | Retrieve the reviews for this article (optional) (default to null)
status = status_example # String | Filter by the status of the review (optional) (default to null)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Institution Curation Reviews
    api_response = api_instance.account_institution_curations(groupId=groupId, articleId=articleId, status=status, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->accountInstitutionCurations: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let groupId = 789; // Long
    let articleId = 789; // Long
    let status = status_example; // String
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.accountInstitutionCurations(groupId, articleId, status, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
group_id
Long (int64)
Filter by the group ID
article_id
Long (int64)
Retrieve the reviews for this article
status
String
Filter by the status of the review
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


customFieldsList

Private account institution group custom fields

Returns the custom fields in the group the user belongs to, or the ones in the group specified, if the user has access.


/account/institution/custom_fields

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/custom_fields?group_id=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Group_id

        try {
            array[ShortCustomField] result = apiInstance.customFieldsList(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#customFieldsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long groupId = new Long(); // Long | Group_id

try {
    final result = await api_instance.customFieldsList(groupId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->customFieldsList: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Group_id

        try {
            array[ShortCustomField] result = apiInstance.customFieldsList(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#customFieldsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *groupId = 789; // Group_id (optional) (default to null)

// Private account institution group custom fields
[apiInstance customFieldsListWith:groupId
              completionHandler: ^(array[ShortCustomField] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var opts = {
  'groupId': 789 // {Long} Group_id
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customFieldsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class customFieldsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var groupId = 789;  // Long | Group_id (optional)  (default to null)

            try {
                // Private account institution group custom fields
                array[ShortCustomField] result = apiInstance.customFieldsList(groupId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.customFieldsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$groupId = 789; // Long | Group_id

try {
    $result = $api_instance->customFieldsList($groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->customFieldsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $groupId = 789; # Long | Group_id

eval {
    my $result = $api_instance->customFieldsList(groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->customFieldsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
groupId = 789 # Long | Group_id (optional) (default to null)

try:
    # Private account institution group custom fields
    api_response = api_instance.custom_fields_list(groupId=groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->customFieldsList: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let groupId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.customFieldsList(groupId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
group_id
Long (int64)
Group_id

Responses


customFieldsUpload

Custom fields values files upload

Uploads a CSV containing values for a specific custom field of type <b>dropdown_large_list</b>. More details in the <a href="#custom_fields">Custom Fields section</a>


/account/institution/custom_fields/{custom_field_id}/items/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.figsh.com/v2/account/institution/custom_fields/{custom_field_id}/items/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long customFieldId = 789; // Long | Custom field identifier
        File externalFile = BINARY_DATA_HERE; // File | CSV file to be uploaded

        try {
            Object result = apiInstance.customFieldsUpload(customFieldId, externalFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#customFieldsUpload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long customFieldId = new Long(); // Long | Custom field identifier
final File externalFile = new File(); // File | CSV file to be uploaded

try {
    final result = await api_instance.customFieldsUpload(customFieldId, externalFile);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->customFieldsUpload: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long customFieldId = 789; // Long | Custom field identifier
        File externalFile = BINARY_DATA_HERE; // File | CSV file to be uploaded

        try {
            Object result = apiInstance.customFieldsUpload(customFieldId, externalFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#customFieldsUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *customFieldId = 789; // Custom field identifier (default to null)
File *externalFile = BINARY_DATA_HERE; // CSV file to be uploaded (optional) (default to null)

// Custom fields values files upload
[apiInstance customFieldsUploadWith:customFieldId
    externalFile:externalFile
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var customFieldId = 789; // {Long} Custom field identifier
var opts = {
  'externalFile': BINARY_DATA_HERE // {File} CSV file to be uploaded
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customFieldsUpload(customFieldId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class customFieldsUploadExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var customFieldId = 789;  // Long | Custom field identifier (default to null)
            var externalFile = BINARY_DATA_HERE;  // File | CSV file to be uploaded (optional)  (default to null)

            try {
                // Custom fields values files upload
                Object result = apiInstance.customFieldsUpload(customFieldId, externalFile);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.customFieldsUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$customFieldId = 789; // Long | Custom field identifier
$externalFile = BINARY_DATA_HERE; // File | CSV file to be uploaded

try {
    $result = $api_instance->customFieldsUpload($customFieldId, $externalFile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->customFieldsUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $customFieldId = 789; # Long | Custom field identifier
my $externalFile = BINARY_DATA_HERE; # File | CSV file to be uploaded

eval {
    my $result = $api_instance->customFieldsUpload(customFieldId => $customFieldId, externalFile => $externalFile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->customFieldsUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
customFieldId = 789 # Long | Custom field identifier (default to null)
externalFile = BINARY_DATA_HERE # File | CSV file to be uploaded (optional) (default to null)

try:
    # Custom fields values files upload
    api_response = api_instance.custom_fields_upload(customFieldId, externalFile=externalFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->customFieldsUpload: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let customFieldId = 789; // Long
    let externalFile = BINARY_DATA_HERE; // File

    let mut context = InstitutionsApi::Context::default();
    let result = client.customFieldsUpload(customFieldId, externalFile, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
custom_field_id*
Long (int64)
Custom field identifier
Required
Form parameters
Name Description
external_file
File (binary)
CSV file to be uploaded

Responses


getAccountInstitutionCurationComments

Institution Curation Review Comments

Retrieve a certain curation review's comments.


/account/institution/review/{curation_id}/comments

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/review/{curation_id}/comments?limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            CurationComment result = apiInstance.getAccountInstitutionCurationComments(curationId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#getAccountInstitutionCurationComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long curationId = new Long(); // Long | ID of the curation
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.getAccountInstitutionCurationComments(curationId, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAccountInstitutionCurationComments: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            CurationComment result = apiInstance.getAccountInstitutionCurationComments(curationId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#getAccountInstitutionCurationComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *curationId = 789; // ID of the curation (default to null)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Institution Curation Review Comments
[apiInstance getAccountInstitutionCurationCommentsWith:curationId
    limit:limit
    offset:offset
              completionHandler: ^(CurationComment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var curationId = 789; // {Long} ID of the curation
var opts = {
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountInstitutionCurationComments(curationId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAccountInstitutionCurationCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var curationId = 789;  // Long | ID of the curation (default to null)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Institution Curation Review Comments
                CurationComment result = apiInstance.getAccountInstitutionCurationComments(curationId, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.getAccountInstitutionCurationComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$curationId = 789; // Long | ID of the curation
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->getAccountInstitutionCurationComments($curationId, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->getAccountInstitutionCurationComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $curationId = 789; # Long | ID of the curation
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->getAccountInstitutionCurationComments(curationId => $curationId, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->getAccountInstitutionCurationComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
curationId = 789 # Long | ID of the curation (default to null)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Institution Curation Review Comments
    api_response = api_instance.get_account_institution_curation_comments(curationId, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->getAccountInstitutionCurationComments: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let curationId = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.getAccountInstitutionCurationComments(curationId, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
curation_id*
Long (int64)
ID of the curation
Required
Query parameters
Name Description
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


institutionArticles

Public Institution Articles

Returns a list of articles belonging to the institution


/institutions/{institution_string_id}/articles/filter-by

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/institutions/{institution_string_id}/articles/filter-by?resource_id=resourceId_example&filename=filename_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        String institutionStringId = institutionStringId_example; // String | 
        String resourceId = resourceId_example; // String | 
        String filename = filename_example; // String | 

        try {
            array[Article] result = apiInstance.institutionArticles(institutionStringId, resourceId, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#institutionArticles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String institutionStringId = new String(); // String | 
final String resourceId = new String(); // String | 
final String filename = new String(); // String | 

try {
    final result = await api_instance.institutionArticles(institutionStringId, resourceId, filename);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->institutionArticles: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        String institutionStringId = institutionStringId_example; // String | 
        String resourceId = resourceId_example; // String | 
        String filename = filename_example; // String | 

        try {
            array[Article] result = apiInstance.institutionArticles(institutionStringId, resourceId, filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#institutionArticles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
String *institutionStringId = institutionStringId_example; //  (default to null)
String *resourceId = resourceId_example; //  (default to null)
String *filename = filename_example; //  (default to null)

// Public Institution Articles
[apiInstance institutionArticlesWith:institutionStringId
    resourceId:resourceId
    filename:filename
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var institutionStringId = institutionStringId_example; // {String} 
var resourceId = resourceId_example; // {String} 
var filename = filename_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.institutionArticles(institutionStringId, resourceId, filename, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class institutionArticlesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var institutionStringId = institutionStringId_example;  // String |  (default to null)
            var resourceId = resourceId_example;  // String |  (default to null)
            var filename = filename_example;  // String |  (default to null)

            try {
                // Public Institution Articles
                array[Article] result = apiInstance.institutionArticles(institutionStringId, resourceId, filename);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.institutionArticles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$institutionStringId = institutionStringId_example; // String | 
$resourceId = resourceId_example; // String | 
$filename = filename_example; // String | 

try {
    $result = $api_instance->institutionArticles($institutionStringId, $resourceId, $filename);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->institutionArticles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $institutionStringId = institutionStringId_example; # String | 
my $resourceId = resourceId_example; # String | 
my $filename = filename_example; # String | 

eval {
    my $result = $api_instance->institutionArticles(institutionStringId => $institutionStringId, resourceId => $resourceId, filename => $filename);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->institutionArticles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
institutionStringId = institutionStringId_example # String |  (default to null)
resourceId = resourceId_example # String |  (default to null)
filename = filename_example # String |  (default to null)

try:
    # Public Institution Articles
    api_response = api_instance.institution_articles(institutionStringId, resourceId, filename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->institutionArticles: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let institutionStringId = institutionStringId_example; // String
    let resourceId = resourceId_example; // String
    let filename = filename_example; // String

    let mut context = InstitutionsApi::Context::default();
    let result = client.institutionArticles(institutionStringId, resourceId, filename, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
institution_string_id*
String
Required
Query parameters
Name Description
resource_id*
String
Required
filename*
String
Required

Responses


institutionHrfeedUpload

Private Institution HRfeed Upload

More info in the <a href="#hr_feed">HR Feed section</a>


/institution/hrfeed/upload

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.figsh.com/v2/institution/hrfeed/upload"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        File hrfeed = BINARY_DATA_HERE; // File | You can find an example in the Hr Feed section

        try {
            ResponseMessage result = apiInstance.institutionHrfeedUpload(hrfeed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#institutionHrfeedUpload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final File hrfeed = new File(); // File | You can find an example in the Hr Feed section

try {
    final result = await api_instance.institutionHrfeedUpload(hrfeed);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->institutionHrfeedUpload: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        File hrfeed = BINARY_DATA_HERE; // File | You can find an example in the Hr Feed section

        try {
            ResponseMessage result = apiInstance.institutionHrfeedUpload(hrfeed);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#institutionHrfeedUpload");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
File *hrfeed = BINARY_DATA_HERE; // You can find an example in the Hr Feed section (optional) (default to null)

// Private Institution HRfeed Upload
[apiInstance institutionHrfeedUploadWith:hrfeed
              completionHandler: ^(ResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var opts = {
  'hrfeed': BINARY_DATA_HERE // {File} You can find an example in the Hr Feed section
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.institutionHrfeedUpload(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class institutionHrfeedUploadExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var hrfeed = BINARY_DATA_HERE;  // File | You can find an example in the Hr Feed section (optional)  (default to null)

            try {
                // Private Institution HRfeed Upload
                ResponseMessage result = apiInstance.institutionHrfeedUpload(hrfeed);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.institutionHrfeedUpload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$hrfeed = BINARY_DATA_HERE; // File | You can find an example in the Hr Feed section

try {
    $result = $api_instance->institutionHrfeedUpload($hrfeed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->institutionHrfeedUpload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $hrfeed = BINARY_DATA_HERE; # File | You can find an example in the Hr Feed section

eval {
    my $result = $api_instance->institutionHrfeedUpload(hrfeed => $hrfeed);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->institutionHrfeedUpload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
hrfeed = BINARY_DATA_HERE # File | You can find an example in the Hr Feed section (optional) (default to null)

try:
    # Private Institution HRfeed Upload
    api_response = api_instance.institution_hrfeed_upload(hrfeed=hrfeed)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->institutionHrfeedUpload: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let hrfeed = BINARY_DATA_HERE; // File

    let mut context = InstitutionsApi::Context::default();
    let result = client.institutionHrfeedUpload(hrfeed, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Form parameters
Name Description
hrfeed
File (binary)
You can find an example in the Hr Feed section

Responses


postAccountInstitutionCurationComments

POST Institution Curation Review Comment

Add a new comment to the review.


/account/institution/review/{curation_id}/comments

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/institution/review/{curation_id}/comments" \
 -d '{
  "text" : "text"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation
        CurationCommentCreate curationComment = ; // CurationCommentCreate | 

        try {
            apiInstance.postAccountInstitutionCurationComments(curationId, curationComment);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#postAccountInstitutionCurationComments");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long curationId = new Long(); // Long | ID of the curation
final CurationCommentCreate curationComment = new CurationCommentCreate(); // CurationCommentCreate | 

try {
    final result = await api_instance.postAccountInstitutionCurationComments(curationId, curationComment);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postAccountInstitutionCurationComments: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long curationId = 789; // Long | ID of the curation
        CurationCommentCreate curationComment = ; // CurationCommentCreate | 

        try {
            apiInstance.postAccountInstitutionCurationComments(curationId, curationComment);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#postAccountInstitutionCurationComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *curationId = 789; // ID of the curation (default to null)
CurationCommentCreate *curationComment = ; // 

// POST Institution Curation Review Comment
[apiInstance postAccountInstitutionCurationCommentsWith:curationId
    curationComment:curationComment
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var curationId = 789; // {Long} ID of the curation
var curationComment = ; // {CurationCommentCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postAccountInstitutionCurationComments(curationId, curationComment, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postAccountInstitutionCurationCommentsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var curationId = 789;  // Long | ID of the curation (default to null)
            var curationComment = new CurationCommentCreate(); // CurationCommentCreate | 

            try {
                // POST Institution Curation Review Comment
                apiInstance.postAccountInstitutionCurationComments(curationId, curationComment);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.postAccountInstitutionCurationComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$curationId = 789; // Long | ID of the curation
$curationComment = ; // CurationCommentCreate | 

try {
    $api_instance->postAccountInstitutionCurationComments($curationId, $curationComment);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->postAccountInstitutionCurationComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $curationId = 789; # Long | ID of the curation
my $curationComment = WWW::OPenAPIClient::Object::CurationCommentCreate->new(); # CurationCommentCreate | 

eval {
    $api_instance->postAccountInstitutionCurationComments(curationId => $curationId, curationComment => $curationComment);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->postAccountInstitutionCurationComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
curationId = 789 # Long | ID of the curation (default to null)
curationComment =  # CurationCommentCreate | 

try:
    # POST Institution Curation Review Comment
    api_instance.post_account_institution_curation_comments(curationId, curationComment)
except ApiException as e:
    print("Exception when calling InstitutionsApi->postAccountInstitutionCurationComments: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let curationId = 789; // Long
    let curationComment = ; // CurationCommentCreate

    let mut context = InstitutionsApi::Context::default();
    let result = client.postAccountInstitutionCurationComments(curationId, curationComment, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
curation_id*
Long (int64)
ID of the curation
Required
Body parameters
Name Description
curationComment *

The content/value of the comment.

Responses


privateAccountInstitutionUser

Private Account Institution User

Retrieve institution user information using the account_id


/account/institution/users/{account_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/users/{account_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            User result = apiInstance.privateAccountInstitutionUser(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateAccountInstitutionUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier the user is associated to

try {
    final result = await api_instance.privateAccountInstitutionUser(accountId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateAccountInstitutionUser: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            User result = apiInstance.privateAccountInstitutionUser(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateAccountInstitutionUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier the user is associated to (default to null)

// Private Account Institution User
[apiInstance privateAccountInstitutionUserWith:accountId
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier the user is associated to

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateAccountInstitutionUser(accountId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateAccountInstitutionUserExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier the user is associated to (default to null)

            try {
                // Private Account Institution User
                User result = apiInstance.privateAccountInstitutionUser(accountId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateAccountInstitutionUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier the user is associated to

try {
    $result = $api_instance->privateAccountInstitutionUser($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateAccountInstitutionUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier the user is associated to

eval {
    my $result = $api_instance->privateAccountInstitutionUser(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateAccountInstitutionUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier the user is associated to (default to null)

try:
    # Private Account Institution User
    api_response = api_instance.private_account_institution_user(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateAccountInstitutionUser: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateAccountInstitutionUser(accountId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier the user is associated to
Required

Responses


privateCategoriesList

Private Account Categories

List institution categories (including parent Categories)


/account/categories

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/categories"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[CategoryList] result = apiInstance.privateCategoriesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateCategoriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateCategoriesList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateCategoriesList: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[CategoryList] result = apiInstance.privateCategoriesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateCategoriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];

// Private Account Categories
[apiInstance privateCategoriesListWithCompletionHandler: 
              ^(array[CategoryList] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateCategoriesList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateCategoriesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();

            try {
                // Private Account Categories
                array[CategoryList] result = apiInstance.privateCategoriesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateCategoriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();

try {
    $result = $api_instance->privateCategoriesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateCategoriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();

eval {
    my $result = $api_instance->privateCategoriesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateCategoriesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()

try:
    # Private Account Categories
    api_response = api_instance.private_categories_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateCategoriesList: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateCategoriesList(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


privateGroupEmbargoOptionsDetails

Private Account Institution Group Embargo Options

Account institution group embargo options details


/account/institution/groups/{group_id}/embargo_options

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/groups/{group_id}/embargo_options"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Group identifier

        try {
            array[GroupEmbargoOptions] result = apiInstance.privateGroupEmbargoOptionsDetails(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateGroupEmbargoOptionsDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long groupId = new Long(); // Long | Group identifier

try {
    final result = await api_instance.privateGroupEmbargoOptionsDetails(groupId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateGroupEmbargoOptionsDetails: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long groupId = 789; // Long | Group identifier

        try {
            array[GroupEmbargoOptions] result = apiInstance.privateGroupEmbargoOptionsDetails(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateGroupEmbargoOptionsDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *groupId = 789; // Group identifier (default to null)

// Private Account Institution Group Embargo Options
[apiInstance privateGroupEmbargoOptionsDetailsWith:groupId
              completionHandler: ^(array[GroupEmbargoOptions] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var groupId = 789; // {Long} Group identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateGroupEmbargoOptionsDetails(groupId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateGroupEmbargoOptionsDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var groupId = 789;  // Long | Group identifier (default to null)

            try {
                // Private Account Institution Group Embargo Options
                array[GroupEmbargoOptions] result = apiInstance.privateGroupEmbargoOptionsDetails(groupId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateGroupEmbargoOptionsDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$groupId = 789; // Long | Group identifier

try {
    $result = $api_instance->privateGroupEmbargoOptionsDetails($groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateGroupEmbargoOptionsDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $groupId = 789; # Long | Group identifier

eval {
    my $result = $api_instance->privateGroupEmbargoOptionsDetails(groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateGroupEmbargoOptionsDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
groupId = 789 # Long | Group identifier (default to null)

try:
    # Private Account Institution Group Embargo Options
    api_response = api_instance.private_group_embargo_options_details(groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateGroupEmbargoOptionsDetails: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let groupId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateGroupEmbargoOptionsDetails(groupId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
group_id*
Long (int64)
Group identifier
Required

Responses


privateInstitutionAccount

Private Institution Account information

Private Institution Account information


/account/institution/accounts/{account_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/accounts/{account_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            Account result = apiInstance.privateInstitutionAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccount");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier the user is associated to

try {
    final result = await api_instance.privateInstitutionAccount(accountId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccount: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            Account result = apiInstance.privateInstitutionAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier the user is associated to (default to null)

// Private Institution Account information
[apiInstance privateInstitutionAccountWith:accountId
              completionHandler: ^(Account output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier the user is associated to

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionAccount(accountId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier the user is associated to (default to null)

            try {
                // Private Institution Account information
                Account result = apiInstance.privateInstitutionAccount(accountId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier the user is associated to

try {
    $result = $api_instance->privateInstitutionAccount($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier the user is associated to

eval {
    my $result = $api_instance->privateInstitutionAccount(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier the user is associated to (default to null)

try:
    # Private Institution Account information
    api_response = api_instance.private_institution_account(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccount: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccount(accountId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier the user is associated to
Required

Responses


privateInstitutionAccountGroupRoleDelete

Delete Institution Account Group Role

Delete Institution Account Group Role


/account/institution/roles/{account_id}/{group_id}/{role_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/roles/{account_id}/{group_id}/{role_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier for which to remove the role
        Long groupId = 789; // Long | Group identifier for which to remove the role
        Long roleId = 789; // Long | Role identifier

        try {
            apiInstance.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRoleDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier for which to remove the role
final Long groupId = new Long(); // Long | Group identifier for which to remove the role
final Long roleId = new Long(); // Long | Role identifier

try {
    final result = await api_instance.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountGroupRoleDelete: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier for which to remove the role
        Long groupId = 789; // Long | Group identifier for which to remove the role
        Long roleId = 789; // Long | Role identifier

        try {
            apiInstance.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRoleDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier for which to remove the role (default to null)
Long *groupId = 789; // Group identifier for which to remove the role (default to null)
Long *roleId = 789; // Role identifier (default to null)

// Delete Institution Account Group Role
[apiInstance privateInstitutionAccountGroupRoleDeleteWith:accountId
    groupId:groupId
    roleId:roleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier for which to remove the role
var groupId = 789; // {Long} Group identifier for which to remove the role
var roleId = 789; // {Long} Role identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountGroupRoleDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier for which to remove the role (default to null)
            var groupId = 789;  // Long | Group identifier for which to remove the role (default to null)
            var roleId = 789;  // Long | Role identifier (default to null)

            try {
                // Delete Institution Account Group Role
                apiInstance.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountGroupRoleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier for which to remove the role
$groupId = 789; // Long | Group identifier for which to remove the role
$roleId = 789; // Long | Role identifier

try {
    $api_instance->privateInstitutionAccountGroupRoleDelete($accountId, $groupId, $roleId);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoleDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier for which to remove the role
my $groupId = 789; # Long | Group identifier for which to remove the role
my $roleId = 789; # Long | Role identifier

eval {
    $api_instance->privateInstitutionAccountGroupRoleDelete(accountId => $accountId, groupId => $groupId, roleId => $roleId);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoleDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier for which to remove the role (default to null)
groupId = 789 # Long | Group identifier for which to remove the role (default to null)
roleId = 789 # Long | Role identifier (default to null)

try:
    # Delete Institution Account Group Role
    api_instance.private_institution_account_group_role_delete(accountId, groupId, roleId)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoleDelete: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long
    let groupId = 789; // Long
    let roleId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountGroupRoleDelete(accountId, groupId, roleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier for which to remove the role
Required
group_id*
Long (int64)
Group identifier for which to remove the role
Required
role_id*
Long (int64)
Role identifier
Required

Responses


privateInstitutionAccountGroupRoles

List Institution Account Group Roles

List Institution Account Group Roles


/account/institution/roles/{account_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/roles/{account_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            Object result = apiInstance.privateInstitutionAccountGroupRoles(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRoles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier the user is associated to

try {
    final result = await api_instance.privateInstitutionAccountGroupRoles(accountId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountGroupRoles: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to

        try {
            Object result = apiInstance.privateInstitutionAccountGroupRoles(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRoles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier the user is associated to (default to null)

// List Institution Account Group Roles
[apiInstance privateInstitutionAccountGroupRolesWith:accountId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier the user is associated to

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionAccountGroupRoles(accountId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountGroupRolesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier the user is associated to (default to null)

            try {
                // List Institution Account Group Roles
                Object result = apiInstance.privateInstitutionAccountGroupRoles(accountId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountGroupRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier the user is associated to

try {
    $result = $api_instance->privateInstitutionAccountGroupRoles($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier the user is associated to

eval {
    my $result = $api_instance->privateInstitutionAccountGroupRoles(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier the user is associated to (default to null)

try:
    # List Institution Account Group Roles
    api_response = api_instance.private_institution_account_group_roles(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountGroupRoles: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountGroupRoles(accountId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier the user is associated to
Required

Responses


privateInstitutionAccountGroupRolesCreate

Add Institution Account Group Roles

Add Institution Account Group Roles


/account/institution/roles/{account_id}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/institution/roles/{account_id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to
        Object account = Object; // Object | 

        try {
            apiInstance.privateInstitutionAccountGroupRolesCreate(accountId, account);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRolesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier the user is associated to
final Object account = new Object(); // Object | 

try {
    final result = await api_instance.privateInstitutionAccountGroupRolesCreate(accountId, account);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountGroupRolesCreate: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to
        Object account = Object; // Object | 

        try {
            apiInstance.privateInstitutionAccountGroupRolesCreate(accountId, account);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountGroupRolesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier the user is associated to (default to null)
Object *account = Object; // 

// Add Institution Account Group Roles
[apiInstance privateInstitutionAccountGroupRolesCreateWith:accountId
    account:account
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier the user is associated to
var account = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateInstitutionAccountGroupRolesCreate(accountId, account, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountGroupRolesCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier the user is associated to (default to null)
            var account = Object;  // Object | 

            try {
                // Add Institution Account Group Roles
                apiInstance.privateInstitutionAccountGroupRolesCreate(accountId, account);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountGroupRolesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier the user is associated to
$account = Object; // Object | 

try {
    $api_instance->privateInstitutionAccountGroupRolesCreate($accountId, $account);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountGroupRolesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier the user is associated to
my $account = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    $api_instance->privateInstitutionAccountGroupRolesCreate(accountId => $accountId, account => $account);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountGroupRolesCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier the user is associated to (default to null)
account = Object # Object | 

try:
    # Add Institution Account Group Roles
    api_instance.private_institution_account_group_roles_create(accountId, account)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountGroupRolesCreate: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long
    let account = Object; // Object

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountGroupRolesCreate(accountId, account, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier the user is associated to
Required
Body parameters
Name Description
account *

Account description

Responses


privateInstitutionAccountsCreate

Create new Institution Account

Create a new Account by sending account information. When the institution_user_id is provided, no verification email will be sent. The email_verified flag will automatically be set to true. If the institution_user_id is not provided, a verification email will be sent. The email_verified flag will be set to true once the account is created.


/account/institution/accounts

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/institution/accounts" \
 -d '{
  "is_active" : true,
  "group_id" : 0,
  "institution_user_id" : "johndoe",
  "quota" : 1000,
  "last_name" : "Doe",
  "first_name" : "John",
  "email" : "johndoe@example.com",
  "symplectic_user_id" : "johndoe"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        AccountCreate account = ; // AccountCreate | 

        try {
            AccountCreateResponse result = apiInstance.privateInstitutionAccountsCreate(account);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AccountCreate account = new AccountCreate(); // AccountCreate | 

try {
    final result = await api_instance.privateInstitutionAccountsCreate(account);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountsCreate: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        AccountCreate account = ; // AccountCreate | 

        try {
            AccountCreateResponse result = apiInstance.privateInstitutionAccountsCreate(account);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
AccountCreate *account = ; // 

// Create new Institution Account
[apiInstance privateInstitutionAccountsCreateWith:account
              completionHandler: ^(AccountCreateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var account = ; // {AccountCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionAccountsCreate(account, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountsCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var account = new AccountCreate(); // AccountCreate | 

            try {
                // Create new Institution Account
                AccountCreateResponse result = apiInstance.privateInstitutionAccountsCreate(account);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$account = ; // AccountCreate | 

try {
    $result = $api_instance->privateInstitutionAccountsCreate($account);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $account = WWW::OPenAPIClient::Object::AccountCreate->new(); # AccountCreate | 

eval {
    my $result = $api_instance->privateInstitutionAccountsCreate(account => $account);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountsCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
account =  # AccountCreate | 

try:
    # Create new Institution Account
    api_response = api_instance.private_institution_accounts_create(account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountsCreate: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let account = ; // AccountCreate

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountsCreate(account, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
account *

Account description

Responses


privateInstitutionAccountsList

Private Account Institution Accounts

Returns the accounts for which the account has administrative privileges (assigned and inherited).


/account/institution/accounts

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/accounts?page=789&page_size=789&limit=789&offset=789&is_active=789&institution_user_id=institutionUserId_example&email=email_example&id_lte=789&id_gte=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        Long isActive = 789; // Long | Filter by active status
        String institutionUserId = institutionUserId_example; // String | Filter by institution_user_id
        String email = email_example; // String | Filter by email
        Long idLte = 789; // Long | Retrieve accounts with an ID lower or equal to the specified value
        Long idGte = 789; // Long | Retrieve accounts with an ID greater or equal to the specified value

        try {
            array[ShortAccount] result = apiInstance.privateInstitutionAccountsList(page, pageSize, limit, offset, isActive, institutionUserId, email, idLte, idGte);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final Long isActive = new Long(); // Long | Filter by active status
final String institutionUserId = new String(); // String | Filter by institution_user_id
final String email = new String(); // String | Filter by email
final Long idLte = new Long(); // Long | Retrieve accounts with an ID lower or equal to the specified value
final Long idGte = new Long(); // Long | Retrieve accounts with an ID greater or equal to the specified value

try {
    final result = await api_instance.privateInstitutionAccountsList(page, pageSize, limit, offset, isActive, institutionUserId, email, idLte, idGte);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountsList: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        Long isActive = 789; // Long | Filter by active status
        String institutionUserId = institutionUserId_example; // String | Filter by institution_user_id
        String email = email_example; // String | Filter by email
        Long idLte = 789; // Long | Retrieve accounts with an ID lower or equal to the specified value
        Long idGte = 789; // Long | Retrieve accounts with an ID greater or equal to the specified value

        try {
            array[ShortAccount] result = apiInstance.privateInstitutionAccountsList(page, pageSize, limit, offset, isActive, institutionUserId, email, idLte, idGte);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
Long *isActive = 789; // Filter by active status (optional) (default to null)
String *institutionUserId = institutionUserId_example; // Filter by institution_user_id (optional) (default to null)
String *email = email_example; // Filter by email (optional) (default to null)
Long *idLte = 789; // Retrieve accounts with an ID lower or equal to the specified value (optional) (default to null)
Long *idGte = 789; // Retrieve accounts with an ID greater or equal to the specified value (optional) (default to null)

// Private Account Institution Accounts
[apiInstance privateInstitutionAccountsListWith:page
    pageSize:pageSize
    limit:limit
    offset:offset
    isActive:isActive
    institutionUserId:institutionUserId
    email:email
    idLte:idLte
    idGte:idGte
              completionHandler: ^(array[ShortAccount] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'isActive': 789, // {Long} Filter by active status
  'institutionUserId': institutionUserId_example, // {String} Filter by institution_user_id
  'email': email_example, // {String} Filter by email
  'idLte': 789, // {Long} Retrieve accounts with an ID lower or equal to the specified value
  'idGte': 789 // {Long} Retrieve accounts with an ID greater or equal to the specified value
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionAccountsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var isActive = 789;  // Long | Filter by active status (optional)  (default to null)
            var institutionUserId = institutionUserId_example;  // String | Filter by institution_user_id (optional)  (default to null)
            var email = email_example;  // String | Filter by email (optional)  (default to null)
            var idLte = 789;  // Long | Retrieve accounts with an ID lower or equal to the specified value (optional)  (default to null)
            var idGte = 789;  // Long | Retrieve accounts with an ID greater or equal to the specified value (optional)  (default to null)

            try {
                // Private Account Institution Accounts
                array[ShortAccount] result = apiInstance.privateInstitutionAccountsList(page, pageSize, limit, offset, isActive, institutionUserId, email, idLte, idGte);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$isActive = 789; // Long | Filter by active status
$institutionUserId = institutionUserId_example; // String | Filter by institution_user_id
$email = email_example; // String | Filter by email
$idLte = 789; // Long | Retrieve accounts with an ID lower or equal to the specified value
$idGte = 789; // Long | Retrieve accounts with an ID greater or equal to the specified value

try {
    $result = $api_instance->privateInstitutionAccountsList($page, $pageSize, $limit, $offset, $isActive, $institutionUserId, $email, $idLte, $idGte);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $isActive = 789; # Long | Filter by active status
my $institutionUserId = institutionUserId_example; # String | Filter by institution_user_id
my $email = email_example; # String | Filter by email
my $idLte = 789; # Long | Retrieve accounts with an ID lower or equal to the specified value
my $idGte = 789; # Long | Retrieve accounts with an ID greater or equal to the specified value

eval {
    my $result = $api_instance->privateInstitutionAccountsList(page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, isActive => $isActive, institutionUserId => $institutionUserId, email => $email, idLte => $idLte, idGte => $idGte);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
isActive = 789 # Long | Filter by active status (optional) (default to null)
institutionUserId = institutionUserId_example # String | Filter by institution_user_id (optional) (default to null)
email = email_example # String | Filter by email (optional) (default to null)
idLte = 789 # Long | Retrieve accounts with an ID lower or equal to the specified value (optional) (default to null)
idGte = 789 # Long | Retrieve accounts with an ID greater or equal to the specified value (optional) (default to null)

try:
    # Private Account Institution Accounts
    api_response = api_instance.private_institution_accounts_list(page=page, pageSize=pageSize, limit=limit, offset=offset, isActive=isActive, institutionUserId=institutionUserId, email=email, idLte=idLte, idGte=idGte)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountsList: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let isActive = 789; // Long
    let institutionUserId = institutionUserId_example; // String
    let email = email_example; // String
    let idLte = 789; // Long
    let idGte = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountsList(page, pageSize, limit, offset, isActive, institutionUserId, email, idLte, idGte, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
is_active
Long (int64)
Filter by active status
institution_user_id
String
Filter by institution_user_id
email
String
Filter by email
id_lte
Long (int64)
Retrieve accounts with an ID lower or equal to the specified value
id_gte
Long (int64)
Retrieve accounts with an ID greater or equal to the specified value

Responses


privateInstitutionAccountsSearch

Private Account Institution Accounts Search

Returns the accounts for which the account has administrative privileges (assigned and inherited).


/account/institution/accounts/search

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/institution/accounts/search" \
 -d '{
  "is_active" : 0,
  "offset" : 0,
  "institution_user_id" : "alan",
  "limit" : 10,
  "page" : 1,
  "search_for" : "figshare",
  "email" : "alan@institution.com",
  "page_size" : 10
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        InstitutionAccountsSearch search = ; // InstitutionAccountsSearch | 

        try {
            array[ShortAccount] result = apiInstance.privateInstitutionAccountsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final InstitutionAccountsSearch search = new InstitutionAccountsSearch(); // InstitutionAccountsSearch | 

try {
    final result = await api_instance.privateInstitutionAccountsSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountsSearch: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        InstitutionAccountsSearch search = ; // InstitutionAccountsSearch | 

        try {
            array[ShortAccount] result = apiInstance.privateInstitutionAccountsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
InstitutionAccountsSearch *search = ; // 

// Private Account Institution Accounts Search
[apiInstance privateInstitutionAccountsSearchWith:search
              completionHandler: ^(array[ShortAccount] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var search = ; // {InstitutionAccountsSearch} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionAccountsSearch(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountsSearchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var search = new InstitutionAccountsSearch(); // InstitutionAccountsSearch | 

            try {
                // Private Account Institution Accounts Search
                array[ShortAccount] result = apiInstance.privateInstitutionAccountsSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$search = ; // InstitutionAccountsSearch | 

try {
    $result = $api_instance->privateInstitutionAccountsSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $search = WWW::OPenAPIClient::Object::InstitutionAccountsSearch->new(); # InstitutionAccountsSearch | 

eval {
    my $result = $api_instance->privateInstitutionAccountsSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
search =  # InstitutionAccountsSearch | 

try:
    # Private Account Institution Accounts Search
    api_response = api_instance.private_institution_accounts_search(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountsSearch: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let search = ; // InstitutionAccountsSearch

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountsSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
search *

Search Parameters

Responses


privateInstitutionAccountsUpdate

Update Institution Account

Update Institution Account


/account/institution/accounts/{account_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/institution/accounts/{account_id}" \
 -d '{
  "is_active" : true,
  "group_id" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to
        AccountUpdate account = ; // AccountUpdate | 

        try {
            apiInstance.privateInstitutionAccountsUpdate(accountId, account);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long accountId = new Long(); // Long | Account identifier the user is associated to
final AccountUpdate account = new AccountUpdate(); // AccountUpdate | 

try {
    final result = await api_instance.privateInstitutionAccountsUpdate(accountId, account);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionAccountsUpdate: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long accountId = 789; // Long | Account identifier the user is associated to
        AccountUpdate account = ; // AccountUpdate | 

        try {
            apiInstance.privateInstitutionAccountsUpdate(accountId, account);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionAccountsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *accountId = 789; // Account identifier the user is associated to (default to null)
AccountUpdate *account = ; // 

// Update Institution Account
[apiInstance privateInstitutionAccountsUpdateWith:accountId
    account:account
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var accountId = 789; // {Long} Account identifier the user is associated to
var account = ; // {AccountUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateInstitutionAccountsUpdate(accountId, account, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionAccountsUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var accountId = 789;  // Long | Account identifier the user is associated to (default to null)
            var account = new AccountUpdate(); // AccountUpdate | 

            try {
                // Update Institution Account
                apiInstance.privateInstitutionAccountsUpdate(accountId, account);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionAccountsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$accountId = 789; // Long | Account identifier the user is associated to
$account = ; // AccountUpdate | 

try {
    $api_instance->privateInstitutionAccountsUpdate($accountId, $account);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionAccountsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $accountId = 789; # Long | Account identifier the user is associated to
my $account = WWW::OPenAPIClient::Object::AccountUpdate->new(); # AccountUpdate | 

eval {
    $api_instance->privateInstitutionAccountsUpdate(accountId => $accountId, account => $account);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionAccountsUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
accountId = 789 # Long | Account identifier the user is associated to (default to null)
account =  # AccountUpdate | 

try:
    # Update Institution Account
    api_instance.private_institution_accounts_update(accountId, account)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionAccountsUpdate: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let accountId = 789; // Long
    let account = ; // AccountUpdate

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionAccountsUpdate(accountId, account, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
account_id*
Long (int64)
Account identifier the user is associated to
Required
Body parameters
Name Description
account *

Account description

Responses

Name Type Format Description
Location String link Location of project


privateInstitutionArticles

Private Institution Articles

Get Articles from own institution. User must be administrator of the institution


/account/institution/articles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/articles?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example&published_since=publishedSince_example&modified_since=modifiedSince_example&status=789&resource_doi=resourceDoi_example&item_type=789&group=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        String modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        Long status = 789; // Long | only return collections with this status
        String resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
        Long itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
        Long group = 789; // Long | only return articles from this group

        try {
            array[Article] result = apiInstance.privateInstitutionArticles(page, pageSize, limit, offset, order, orderDirection, publishedSince, modifiedSince, status, resourceDoi, itemType, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionArticles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order. Default varies by endpoint/resource.
final String orderDirection = new String(); // String | 
final String publishedSince = new String(); // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
final String modifiedSince = new String(); // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
final Long status = new Long(); // Long | only return collections with this status
final String resourceDoi = new String(); // String | only return collections with this resource_doi
final Long itemType = new Long(); // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
final Long group = new Long(); // Long | only return articles from this group

try {
    final result = await api_instance.privateInstitutionArticles(page, pageSize, limit, offset, order, orderDirection, publishedSince, modifiedSince, status, resourceDoi, itemType, group);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionArticles: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        String modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
        Long status = 789; // Long | only return collections with this status
        String resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
        Long itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
        Long group = 789; // Long | only return articles from this group

        try {
            array[Article] result = apiInstance.privateInstitutionArticles(page, pageSize, limit, offset, order, orderDirection, publishedSince, modifiedSince, status, resourceDoi, itemType, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionArticles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)
String *publishedSince = publishedSince_example; // Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
String *modifiedSince = modifiedSince_example; // Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
Long *status = 789; // only return collections with this status (optional) (default to null)
String *resourceDoi = resourceDoi_example; // only return collections with this resource_doi (optional) (default to null)
Long *itemType = 789; // Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional) (default to null)
Long *group = 789; // only return articles from this group (optional) (default to null)

// Private Institution Articles
[apiInstance privateInstitutionArticlesWith:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
    publishedSince:publishedSince
    modifiedSince:modifiedSince
    status:status
    resourceDoi:resourceDoi
    itemType:itemType
    group:group
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order. Default varies by endpoint/resource.
  'orderDirection': orderDirection_example, // {String} 
  'publishedSince': publishedSince_example, // {String} Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
  'modifiedSince': modifiedSince_example, // {String} Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
  'status': 789, // {Long} only return collections with this status
  'resourceDoi': resourceDoi_example, // {String} only return collections with this resource_doi
  'itemType': 789, // {Long} Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
  'group': 789 // {Long} only return articles from this group
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionArticles(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionArticlesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. Default varies by endpoint/resource. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)
            var publishedSince = publishedSince_example;  // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional)  (default to null)
            var modifiedSince = modifiedSince_example;  // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional)  (default to null)
            var status = 789;  // Long | only return collections with this status (optional)  (default to null)
            var resourceDoi = resourceDoi_example;  // String | only return collections with this resource_doi (optional)  (default to null)
            var itemType = 789;  // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional)  (default to null)
            var group = 789;  // Long | only return articles from this group (optional)  (default to null)

            try {
                // Private Institution Articles
                array[Article] result = apiInstance.privateInstitutionArticles(page, pageSize, limit, offset, order, orderDirection, publishedSince, modifiedSince, status, resourceDoi, itemType, group);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionArticles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
$orderDirection = orderDirection_example; // String | 
$publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
$modifiedSince = modifiedSince_example; // String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
$status = 789; // Long | only return collections with this status
$resourceDoi = resourceDoi_example; // String | only return collections with this resource_doi
$itemType = 789; // Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
$group = 789; // Long | only return articles from this group

try {
    $result = $api_instance->privateInstitutionArticles($page, $pageSize, $limit, $offset, $order, $orderDirection, $publishedSince, $modifiedSince, $status, $resourceDoi, $itemType, $group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionArticles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order. Default varies by endpoint/resource.
my $orderDirection = orderDirection_example; # String | 
my $publishedSince = publishedSince_example; # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
my $modifiedSince = modifiedSince_example; # String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
my $status = 789; # Long | only return collections with this status
my $resourceDoi = resourceDoi_example; # String | only return collections with this resource_doi
my $itemType = 789; # Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
my $group = 789; # Long | only return articles from this group

eval {
    my $result = $api_instance->privateInstitutionArticles(page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection, publishedSince => $publishedSince, modifiedSince => $modifiedSince, status => $status, resourceDoi => $resourceDoi, itemType => $itemType, group => $group);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionArticles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)
publishedSince = publishedSince_example # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
modifiedSince = modifiedSince_example # String | Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ (optional) (default to null)
status = 789 # Long | only return collections with this status (optional) (default to null)
resourceDoi = resourceDoi_example # String | only return collections with this resource_doi (optional) (default to null)
itemType = 789 # Long | Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model (optional) (default to null)
group = 789 # Long | only return articles from this group (optional) (default to null)

try:
    # Private Institution Articles
    api_response = api_instance.private_institution_articles(page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection, publishedSince=publishedSince, modifiedSince=modifiedSince, status=status, resourceDoi=resourceDoi, itemType=itemType, group=group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionArticles: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String
    let publishedSince = publishedSince_example; // String
    let modifiedSince = modifiedSince_example; // String
    let status = 789; // Long
    let resourceDoi = resourceDoi_example; // String
    let itemType = 789; // Long
    let group = 789; // Long

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionArticles(page, pageSize, limit, offset, order, orderDirection, publishedSince, modifiedSince, status, resourceDoi, itemType, group, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order. Default varies by endpoint/resource.
order_direction
String
published_since
String
Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
modified_since
String
Filter by article modified date. Will only return articles modified after the date. date(ISO 8601) YYYY-MM-DD or date-time(ISO 8601) YYYY-MM-DDTHH:mm:ssZ
status
Long (int64)
only return collections with this status
resource_doi
String
only return collections with this resource_doi
item_type
Long (int64)
Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model
group
Long (int64)
only return articles from this group

Responses


privateInstitutionDetails

Private Account Institutions

Account institution details


/account/institution

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            Institution result = apiInstance.privateInstitutionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateInstitutionDetails();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionDetails: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            Institution result = apiInstance.privateInstitutionDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];

// Private Account Institutions
[apiInstance privateInstitutionDetailsWithCompletionHandler: 
              ^(Institution output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();

            try {
                // Private Account Institutions
                Institution result = apiInstance.privateInstitutionDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();

try {
    $result = $api_instance->privateInstitutionDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();

eval {
    my $result = $api_instance->privateInstitutionDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()

try:
    # Private Account Institutions
    api_response = api_instance.private_institution_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionDetails: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


privateInstitutionEmbargoOptionsDetails

Private Account Institution embargo options

Account institution embargo options details


/account/institution/embargo_options

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/embargo_options"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[GroupEmbargoOptions] result = apiInstance.privateInstitutionEmbargoOptionsDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionEmbargoOptionsDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateInstitutionEmbargoOptionsDetails();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionEmbargoOptionsDetails: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[GroupEmbargoOptions] result = apiInstance.privateInstitutionEmbargoOptionsDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionEmbargoOptionsDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];

// Private Account Institution embargo options
[apiInstance privateInstitutionEmbargoOptionsDetailsWithCompletionHandler: 
              ^(array[GroupEmbargoOptions] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionEmbargoOptionsDetails(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionEmbargoOptionsDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();

            try {
                // Private Account Institution embargo options
                array[GroupEmbargoOptions] result = apiInstance.privateInstitutionEmbargoOptionsDetails();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionEmbargoOptionsDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();

try {
    $result = $api_instance->privateInstitutionEmbargoOptionsDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionEmbargoOptionsDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();

eval {
    my $result = $api_instance->privateInstitutionEmbargoOptionsDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionEmbargoOptionsDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()

try:
    # Private Account Institution embargo options
    api_response = api_instance.private_institution_embargo_options_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionEmbargoOptionsDetails: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionEmbargoOptionsDetails(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


privateInstitutionGroupsList

Private Account Institution Groups

Returns the groups for which the account has administrative privileges (assigned and inherited).


/account/institution/groups

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/groups"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[Group] result = apiInstance.privateInstitutionGroupsList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionGroupsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateInstitutionGroupsList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionGroupsList: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[Group] result = apiInstance.privateInstitutionGroupsList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionGroupsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];

// Private Account Institution Groups
[apiInstance privateInstitutionGroupsListWithCompletionHandler: 
              ^(array[Group] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionGroupsList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionGroupsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();

            try {
                // Private Account Institution Groups
                array[Group] result = apiInstance.privateInstitutionGroupsList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionGroupsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();

try {
    $result = $api_instance->privateInstitutionGroupsList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionGroupsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();

eval {
    my $result = $api_instance->privateInstitutionGroupsList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionGroupsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()

try:
    # Private Account Institution Groups
    api_response = api_instance.private_institution_groups_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionGroupsList: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionGroupsList(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


privateInstitutionRolesList

Private Account Institution Roles

Returns the roles available for groups and the institution group.


/account/institution/roles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/institution/roles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstitutionsApi;

import java.io.File;
import java.util.*;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[Role] result = apiInstance.privateInstitutionRolesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionRolesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateInstitutionRolesList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateInstitutionRolesList: $e\n');
}

import org.openapitools.client.api.InstitutionsApi;

public class InstitutionsApiExample {
    public static void main(String[] args) {
        InstitutionsApi apiInstance = new InstitutionsApi();

        try {
            array[Role] result = apiInstance.privateInstitutionRolesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstitutionsApi#privateInstitutionRolesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
InstitutionsApi *apiInstance = [[InstitutionsApi alloc] init];

// Private Account Institution Roles
[apiInstance privateInstitutionRolesListWithCompletionHandler: 
              ^(array[Role] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.InstitutionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateInstitutionRolesList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateInstitutionRolesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstitutionsApi();

            try {
                // Private Account Institution Roles
                array[Role] result = apiInstance.privateInstitutionRolesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstitutionsApi.privateInstitutionRolesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstitutionsApi();

try {
    $result = $api_instance->privateInstitutionRolesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstitutionsApi->privateInstitutionRolesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstitutionsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstitutionsApi->new();

eval {
    my $result = $api_instance->privateInstitutionRolesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstitutionsApi->privateInstitutionRolesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstitutionsApi()

try:
    # Private Account Institution Roles
    api_response = api_instance.private_institution_roles_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstitutionsApi->privateInstitutionRolesList: %s\n" % e)
extern crate InstitutionsApi;

pub fn main() {

    let mut context = InstitutionsApi::Context::default();
    let result = client.privateInstitutionRolesList(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


Oauth

createToken

Create OAuth token

Creates OAuth token using various grant types


/token

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/token" \
 -d '{
  "refresh_token" : "refresh_token",
  "password" : "password",
  "code" : "code",
  "grant_type" : "authorization_code",
  "client_secret" : "client_secret",
  "client_id" : "client_id",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OauthApi;

import java.io.File;
import java.util.*;

public class OauthApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OauthApi apiInstance = new OauthApi();
        CreateOAuthToken body = ; // CreateOAuthToken | 

        try {
            OAuthToken result = apiInstance.createToken(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthApi#createToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateOAuthToken body = new CreateOAuthToken(); // CreateOAuthToken | 

try {
    final result = await api_instance.createToken(body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createToken: $e\n');
}

import org.openapitools.client.api.OauthApi;

public class OauthApiExample {
    public static void main(String[] args) {
        OauthApi apiInstance = new OauthApi();
        CreateOAuthToken body = ; // CreateOAuthToken | 

        try {
            OAuthToken result = apiInstance.createToken(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthApi#createToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OauthApi *apiInstance = [[OauthApi alloc] init];
CreateOAuthToken *body = ; //  (optional)

// Create OAuth token
[apiInstance createTokenWith:body
              completionHandler: ^(OAuthToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.OauthApi()
var opts = {
  'body':  // {CreateOAuthToken} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createToken(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createTokenExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new OauthApi();
            var body = new CreateOAuthToken(); // CreateOAuthToken |  (optional) 

            try {
                // Create OAuth token
                OAuthToken result = apiInstance.createToken(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OauthApi.createToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OauthApi();
$body = ; // CreateOAuthToken | 

try {
    $result = $api_instance->createToken($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OauthApi->createToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OauthApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OauthApi->new();
my $body = WWW::OPenAPIClient::Object::CreateOAuthToken->new(); # CreateOAuthToken | 

eval {
    my $result = $api_instance->createToken(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OauthApi->createToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OauthApi()
body =  # CreateOAuthToken |  (optional)

try:
    # Create OAuth token
    api_response = api_instance.create_token(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OauthApi->createToken: %s\n" % e)
extern crate OauthApi;

pub fn main() {
    let body = ; // CreateOAuthToken

    let mut context = OauthApi::Context::default();
    let result = client.createToken(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body

Create OAuth Token Parameters

Responses


getTokenInfo

Get OAuth token information

Returns information about the current OAuth token


/token

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/token?access_token=accessToken_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OauthApi;

import java.io.File;
import java.util.*;

public class OauthApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OauthApi apiInstance = new OauthApi();
        String accessToken = accessToken_example; // String | OAuth access token

        try {
            OAuthToken result = apiInstance.getTokenInfo(accessToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthApi#getTokenInfo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accessToken = new String(); // String | OAuth access token

try {
    final result = await api_instance.getTokenInfo(accessToken);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTokenInfo: $e\n');
}

import org.openapitools.client.api.OauthApi;

public class OauthApiExample {
    public static void main(String[] args) {
        OauthApi apiInstance = new OauthApi();
        String accessToken = accessToken_example; // String | OAuth access token

        try {
            OAuthToken result = apiInstance.getTokenInfo(accessToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OauthApi#getTokenInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OauthApi *apiInstance = [[OauthApi alloc] init];
String *accessToken = accessToken_example; // OAuth access token (optional) (default to null)

// Get OAuth token information
[apiInstance getTokenInfoWith:accessToken
              completionHandler: ^(OAuthToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.OauthApi()
var opts = {
  'accessToken': accessToken_example // {String} OAuth access token
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTokenInfo(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTokenInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new OauthApi();
            var accessToken = accessToken_example;  // String | OAuth access token (optional)  (default to null)

            try {
                // Get OAuth token information
                OAuthToken result = apiInstance.getTokenInfo(accessToken);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OauthApi.getTokenInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OauthApi();
$accessToken = accessToken_example; // String | OAuth access token

try {
    $result = $api_instance->getTokenInfo($accessToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OauthApi->getTokenInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OauthApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OauthApi->new();
my $accessToken = accessToken_example; # String | OAuth access token

eval {
    my $result = $api_instance->getTokenInfo(accessToken => $accessToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OauthApi->getTokenInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OauthApi()
accessToken = accessToken_example # String | OAuth access token (optional) (default to null)

try:
    # Get OAuth token information
    api_response = api_instance.get_token_info(accessToken=accessToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OauthApi->getTokenInfo: %s\n" % e)
extern crate OauthApi;

pub fn main() {
    let accessToken = accessToken_example; // String

    let mut context = OauthApi::Context::default();
    let result = client.getTokenInfo(accessToken, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
access_token
String
OAuth access token

Responses


Other

categoriesList

Public Categories

Returns a list of public categories


/categories

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/categories"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();

        try {
            array[CategoryList] result = apiInstance.categoriesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#categoriesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.categoriesList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->categoriesList: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();

        try {
            array[CategoryList] result = apiInstance.categoriesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#categoriesList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];

// Public Categories
[apiInstance categoriesListWithCompletionHandler: 
              ^(array[CategoryList] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.categoriesList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class categoriesListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new OtherApi();

            try {
                // Public Categories
                array[CategoryList] result = apiInstance.categoriesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.categoriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();

try {
    $result = $api_instance->categoriesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->categoriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();

eval {
    my $result = $api_instance->categoriesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->categoriesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OtherApi()

try:
    # Public Categories
    api_response = api_instance.categories_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->categoriesList: %s\n" % e)
extern crate OtherApi;

pub fn main() {

    let mut context = OtherApi::Context::default();
    let result = client.categoriesList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


fileDownload

Public File Download

Starts the download of a file


/file/download/{file_id}

Usage and SDK Samples

curl -X GET \
 "https://api.figsh.com/v2/file/download/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();
        Long fileId = 789; // Long | 

        try {
            apiInstance.fileDownload(fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#fileDownload");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long fileId = new Long(); // Long | 

try {
    final result = await api_instance.fileDownload(fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->fileDownload: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();
        Long fileId = 789; // Long | 

        try {
            apiInstance.fileDownload(fileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#fileDownload");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];
Long *fileId = 789; //  (default to null)

// Public File Download
[apiInstance fileDownloadWith:fileId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var fileId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.fileDownload(fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class fileDownloadExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new OtherApi();
            var fileId = 789;  // Long |  (default to null)

            try {
                // Public File Download
                apiInstance.fileDownload(fileId);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.fileDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();
$fileId = 789; // Long | 

try {
    $api_instance->fileDownload($fileId);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->fileDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();
my $fileId = 789; # Long | 

eval {
    $api_instance->fileDownload(fileId => $fileId);
};
if ($@) {
    warn "Exception when calling OtherApi->fileDownload: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OtherApi()
fileId = 789 # Long |  (default to null)

try:
    # Public File Download
    api_instance.file_download(fileId)
except ApiException as e:
    print("Exception when calling OtherApi->fileDownload: %s\n" % e)
extern crate OtherApi;

pub fn main() {
    let fileId = 789; // Long

    let mut context = OtherApi::Context::default();
    let result = client.fileDownload(fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
file_id*
Long (int64)
Required

Responses


itemTypesList

Item Types

Returns the list of Item Types of the requested group. If no user is authenticated, returns the item types available for Figshare.


/item_types

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/item_types?group_id=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();
        Long groupId = 789; // Long | Identifier of the group for which the item types are requested

        try {
            array[ItemType] result = apiInstance.itemTypesList(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#itemTypesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long groupId = new Long(); // Long | Identifier of the group for which the item types are requested

try {
    final result = await api_instance.itemTypesList(groupId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->itemTypesList: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();
        Long groupId = 789; // Long | Identifier of the group for which the item types are requested

        try {
            array[ItemType] result = apiInstance.itemTypesList(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#itemTypesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];
Long *groupId = 789; // Identifier of the group for which the item types are requested (optional) (default to 0)

// Item Types
[apiInstance itemTypesListWith:groupId
              completionHandler: ^(array[ItemType] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var opts = {
  'groupId': 789 // {Long} Identifier of the group for which the item types are requested
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.itemTypesList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class itemTypesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OtherApi();
            var groupId = 789;  // Long | Identifier of the group for which the item types are requested (optional)  (default to 0)

            try {
                // Item Types
                array[ItemType] result = apiInstance.itemTypesList(groupId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.itemTypesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();
$groupId = 789; // Long | Identifier of the group for which the item types are requested

try {
    $result = $api_instance->itemTypesList($groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->itemTypesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();
my $groupId = 789; # Long | Identifier of the group for which the item types are requested

eval {
    my $result = $api_instance->itemTypesList(groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->itemTypesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OtherApi()
groupId = 789 # Long | Identifier of the group for which the item types are requested (optional) (default to 0)

try:
    # Item Types
    api_response = api_instance.item_types_list(groupId=groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->itemTypesList: %s\n" % e)
extern crate OtherApi;

pub fn main() {
    let groupId = 789; // Long

    let mut context = OtherApi::Context::default();
    let result = client.itemTypesList(groupId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
group_id
Long (int64)
Identifier of the group for which the item types are requested

Responses


licensesList

Public Licenses

Returns a list of public licenses


/licenses

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/licenses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();

        try {
            array[License] result = apiInstance.licensesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#licensesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.licensesList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->licensesList: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();

        try {
            array[License] result = apiInstance.licensesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#licensesList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];

// Public Licenses
[apiInstance licensesListWithCompletionHandler: 
              ^(array[License] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.licensesList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class licensesListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new OtherApi();

            try {
                // Public Licenses
                array[License] result = apiInstance.licensesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.licensesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();

try {
    $result = $api_instance->licensesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->licensesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();

eval {
    my $result = $api_instance->licensesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->licensesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OtherApi()

try:
    # Public Licenses
    api_response = api_instance.licenses_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->licensesList: %s\n" % e)
extern crate OtherApi;

pub fn main() {

    let mut context = OtherApi::Context::default();
    let result = client.licensesList(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


privateAccount

Private Account information

Account information for token/personal token


/account

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();

        try {
            Account result = apiInstance.privateAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateAccount");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateAccount();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateAccount: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();

        try {
            Account result = apiInstance.privateAccount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];

// Private Account information
[apiInstance privateAccountWithCompletionHandler: 
              ^(Account output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateAccount(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateAccountExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OtherApi();

            try {
                // Private Account information
                Account result = apiInstance.privateAccount();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.privateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();

try {
    $result = $api_instance->privateAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->privateAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();

eval {
    my $result = $api_instance->privateAccount();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->privateAccount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OtherApi()

try:
    # Private Account information
    api_response = api_instance.private_account()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->privateAccount: %s\n" % e)
extern crate OtherApi;

pub fn main() {

    let mut context = OtherApi::Context::default();
    let result = client.privateAccount(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


privateFundingSearch

Search Funding

Search for fundings


/account/funding/search

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/funding/search" \
 -d '{
  "search_for" : "search_for"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();
        FundingSearch search = ; // FundingSearch | 

        try {
            array[FundingInformation] result = apiInstance.privateFundingSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateFundingSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final FundingSearch search = new FundingSearch(); // FundingSearch | 

try {
    final result = await api_instance.privateFundingSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateFundingSearch: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();
        FundingSearch search = ; // FundingSearch | 

        try {
            array[FundingInformation] result = apiInstance.privateFundingSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateFundingSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];
FundingSearch *search = ; //  (optional)

// Search Funding
[apiInstance privateFundingSearchWith:search
              completionHandler: ^(array[FundingInformation] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var opts = {
  'search':  // {FundingSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateFundingSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateFundingSearchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OtherApi();
            var search = new FundingSearch(); // FundingSearch |  (optional) 

            try {
                // Search Funding
                array[FundingInformation] result = apiInstance.privateFundingSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.privateFundingSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();
$search = ; // FundingSearch | 

try {
    $result = $api_instance->privateFundingSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->privateFundingSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();
my $search = WWW::OPenAPIClient::Object::FundingSearch->new(); # FundingSearch | 

eval {
    my $result = $api_instance->privateFundingSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->privateFundingSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OtherApi()
search =  # FundingSearch |  (optional)

try:
    # Search Funding
    api_response = api_instance.private_funding_search(search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->privateFundingSearch: %s\n" % e)
extern crate OtherApi;

pub fn main() {
    let search = ; // FundingSearch

    let mut context = OtherApi::Context::default();
    let result = client.privateFundingSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
search

Search Parameters

Responses


privateLicensesList

Private Account Licenses

This is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution.


/account/licenses

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/licenses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OtherApi;

import java.io.File;
import java.util.*;

public class OtherApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        OtherApi apiInstance = new OtherApi();

        try {
            array[License] result = apiInstance.privateLicensesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateLicensesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.privateLicensesList();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateLicensesList: $e\n');
}

import org.openapitools.client.api.OtherApi;

public class OtherApiExample {
    public static void main(String[] args) {
        OtherApi apiInstance = new OtherApi();

        try {
            array[License] result = apiInstance.privateLicensesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OtherApi#privateLicensesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
OtherApi *apiInstance = [[OtherApi alloc] init];

// Private Account Licenses
[apiInstance privateLicensesListWithCompletionHandler: 
              ^(array[License] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.OtherApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateLicensesList(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateLicensesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new OtherApi();

            try {
                // Private Account Licenses
                array[License] result = apiInstance.privateLicensesList();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OtherApi.privateLicensesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OtherApi();

try {
    $result = $api_instance->privateLicensesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OtherApi->privateLicensesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OtherApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OtherApi->new();

eval {
    my $result = $api_instance->privateLicensesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OtherApi->privateLicensesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.OtherApi()

try:
    # Private Account Licenses
    api_response = api_instance.private_licenses_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OtherApi->privateLicensesList: %s\n" % e)
extern crate OtherApi;

pub fn main() {

    let mut context = OtherApi::Context::default();
    let result = client.privateLicensesList(&context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Responses


Profiles

updateUserProfile

Update public profile

Updates the fields of the user's public profile.


/account/profile

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/profile?user_id=789&institution_user_id=institutionUserId_example" \
 -d '{
  "facebook" : "https://facebook.com/profile/1",
  "x" : "https://x.com/profile/1",
  "last_name" : "Doe",
  "fields_of_interest" : [ 1, 2 ],
  "bio" : "Biographical information",
  "orcid" : "0000-0001-YYYY-XXXX",
  "location" : "London, UK",
  "linkedin" : "https://linkedin.com/profile/2",
  "first_name" : "John",
  "job_title" : "Researcher at institution X",
  "fields_of_interest_by_source_id" : [ "3204", "320401" ],
  "personal_profiles" : [ {
    "label" : "ResearchGate",
    "url" : "https://researchgate.net/profile/1"
  }, {
    "label" : "",
    "url" : "https://academia.edu/profile/1"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        ProfileUpdateData user profile data = ; // ProfileUpdateData | 
        Long userId = 789; // Long | User ID
        String institutionUserId = institutionUserId_example; // String | Institutional user ID

        try {
            Object result = apiInstance.updateUserProfile(user profile data, userId, institutionUserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#updateUserProfile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ProfileUpdateData user profile data = new ProfileUpdateData(); // ProfileUpdateData | 
final Long userId = new Long(); // Long | User ID
final String institutionUserId = new String(); // String | Institutional user ID

try {
    final result = await api_instance.updateUserProfile(user profile data, userId, institutionUserId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserProfile: $e\n');
}

import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        ProfileUpdateData user profile data = ; // ProfileUpdateData | 
        Long userId = 789; // Long | User ID
        String institutionUserId = institutionUserId_example; // String | Institutional user ID

        try {
            Object result = apiInstance.updateUserProfile(user profile data, userId, institutionUserId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#updateUserProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
ProfileUpdateData *user profile data = ; // 
Long *userId = 789; // User ID (optional) (default to null)
String *institutionUserId = institutionUserId_example; // Institutional user ID (optional) (default to null)

// Update public profile
[apiInstance updateUserProfileWith:user profile data
    userId:userId
    institutionUserId:institutionUserId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProfilesApi()
var user profile data = ; // {ProfileUpdateData} 
var opts = {
  'userId': 789, // {Long} User ID
  'institutionUserId': institutionUserId_example // {String} Institutional user ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserProfile(user profile data, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserProfileExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var user profile data = new ProfileUpdateData(); // ProfileUpdateData | 
            var userId = 789;  // Long | User ID (optional)  (default to null)
            var institutionUserId = institutionUserId_example;  // String | Institutional user ID (optional)  (default to null)

            try {
                // Update public profile
                Object result = apiInstance.updateUserProfile(user profile data, userId, institutionUserId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.updateUserProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$user profile data = ; // ProfileUpdateData | 
$userId = 789; // Long | User ID
$institutionUserId = institutionUserId_example; // String | Institutional user ID

try {
    $result = $api_instance->updateUserProfile($user profile data, $userId, $institutionUserId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->updateUserProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $user profile data = WWW::OPenAPIClient::Object::ProfileUpdateData->new(); # ProfileUpdateData | 
my $userId = 789; # Long | User ID
my $institutionUserId = institutionUserId_example; # String | Institutional user ID

eval {
    my $result = $api_instance->updateUserProfile(user profile data => $user profile data, userId => $userId, institutionUserId => $institutionUserId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->updateUserProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
user profile data =  # ProfileUpdateData | 
userId = 789 # Long | User ID (optional) (default to null)
institutionUserId = institutionUserId_example # String | Institutional user ID (optional) (default to null)

try:
    # Update public profile
    api_response = api_instance.update_user_profile(user profile data, userId=userId, institutionUserId=institutionUserId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->updateUserProfile: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let user profile data = ; // ProfileUpdateData
    let userId = 789; // Long
    let institutionUserId = institutionUserId_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.updateUserProfile(user profile data, userId, institutionUserId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
user profile data *

Query parameters
Name Description
user_id
Long (int64)
User ID
institution_user_id
String
Institutional user ID

Responses


updateUserProfilePicture

Update public profile picture

Updates the profile picture of the user's public profile.


/account/profile/{user_id}/picture

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://api.figsh.com/v2/account/profile/{user_id}/picture"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        Long userId = 789; // Long | User ID
        File profilePicture = BINARY_DATA_HERE; // File | User profile picture

        try {
            Object result = apiInstance.updateUserProfilePicture(userId, profilePicture);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#updateUserProfilePicture");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long userId = new Long(); // Long | User ID
final File profilePicture = new File(); // File | User profile picture

try {
    final result = await api_instance.updateUserProfilePicture(userId, profilePicture);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUserProfilePicture: $e\n');
}

import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        Long userId = 789; // Long | User ID
        File profilePicture = BINARY_DATA_HERE; // File | User profile picture

        try {
            Object result = apiInstance.updateUserProfilePicture(userId, profilePicture);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#updateUserProfilePicture");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
Long *userId = 789; // User ID (default to null)
File *profilePicture = BINARY_DATA_HERE; // User profile picture (default to null)

// Update public profile picture
[apiInstance updateUserProfilePictureWith:userId
    profilePicture:profilePicture
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProfilesApi()
var userId = 789; // {Long} User ID
var profilePicture = BINARY_DATA_HERE; // {File} User profile picture

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserProfilePicture(userId, profilePicture, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserProfilePictureExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var userId = 789;  // Long | User ID (default to null)
            var profilePicture = BINARY_DATA_HERE;  // File | User profile picture (default to null)

            try {
                // Update public profile picture
                Object result = apiInstance.updateUserProfilePicture(userId, profilePicture);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.updateUserProfilePicture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$userId = 789; // Long | User ID
$profilePicture = BINARY_DATA_HERE; // File | User profile picture

try {
    $result = $api_instance->updateUserProfilePicture($userId, $profilePicture);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->updateUserProfilePicture: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $userId = 789; # Long | User ID
my $profilePicture = BINARY_DATA_HERE; # File | User profile picture

eval {
    my $result = $api_instance->updateUserProfilePicture(userId => $userId, profilePicture => $profilePicture);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->updateUserProfilePicture: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
userId = 789 # Long | User ID (default to null)
profilePicture = BINARY_DATA_HERE # File | User profile picture (default to null)

try:
    # Update public profile picture
    api_response = api_instance.update_user_profile_picture(userId, profilePicture)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->updateUserProfilePicture: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let userId = 789; // Long
    let profilePicture = BINARY_DATA_HERE; // File

    let mut context = ProfilesApi::Context::default();
    let result = client.updateUserProfilePicture(userId, profilePicture, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
user_id*
Long (int64)
User ID
Required
Form parameters
Name Description
profile_picture*
File (binary)
User profile picture
Required

Responses


Projects

privateProjectArticleDelete

Delete project article

Delete project article


/account/projects/{project_id}/articles/{article_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            apiInstance.privateProjectArticleDelete(projectId, articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long articleId = new Long(); // Long | Project Article unique identifier

try {
    final result = await api_instance.privateProjectArticleDelete(projectId, articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticleDelete: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            apiInstance.privateProjectArticleDelete(projectId, articleId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *articleId = 789; // Project Article unique identifier (default to null)

// Delete project article
[apiInstance privateProjectArticleDeleteWith:projectId
    articleId:articleId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var articleId = 789; // {Long} Project Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectArticleDelete(projectId, articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticleDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var articleId = 789;  // Long | Project Article unique identifier (default to null)

            try {
                // Delete project article
                apiInstance.privateProjectArticleDelete(projectId, articleId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$articleId = 789; // Long | Project Article unique identifier

try {
    $api_instance->privateProjectArticleDelete($projectId, $articleId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticleDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $articleId = 789; # Long | Project Article unique identifier

eval {
    $api_instance->privateProjectArticleDelete(projectId => $projectId, articleId => $articleId);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticleDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
articleId = 789 # Long | Project Article unique identifier (default to null)

try:
    # Delete project article
    api_instance.private_project_article_delete(projectId, articleId)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticleDelete: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let articleId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticleDelete(projectId, articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
article_id*
Long (int64)
Project Article unique identifier
Required

Responses


privateProjectArticleDetails

Project article details

Project article details


/account/projects/{project_id}/articles/{article_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles/{article_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            ArticleCompletePrivate result = apiInstance.privateProjectArticleDetails(projectId, articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long articleId = new Long(); // Long | Project Article unique identifier

try {
    final result = await api_instance.privateProjectArticleDetails(projectId, articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticleDetails: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            ArticleCompletePrivate result = apiInstance.privateProjectArticleDetails(projectId, articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *articleId = 789; // Project Article unique identifier (default to null)

// Project article details
[apiInstance privateProjectArticleDetailsWith:projectId
    articleId:articleId
              completionHandler: ^(ArticleCompletePrivate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var articleId = 789; // {Long} Project Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectArticleDetails(projectId, articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticleDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var articleId = 789;  // Long | Project Article unique identifier (default to null)

            try {
                // Project article details
                ArticleCompletePrivate result = apiInstance.privateProjectArticleDetails(projectId, articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticleDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$articleId = 789; // Long | Project Article unique identifier

try {
    $result = $api_instance->privateProjectArticleDetails($projectId, $articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticleDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $articleId = 789; # Long | Project Article unique identifier

eval {
    my $result = $api_instance->privateProjectArticleDetails(projectId => $projectId, articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticleDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
articleId = 789 # Long | Project Article unique identifier (default to null)

try:
    # Project article details
    api_response = api_instance.private_project_article_details(projectId, articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticleDetails: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let articleId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticleDetails(projectId, articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
article_id*
Long (int64)
Project Article unique identifier
Required

Responses


privateProjectArticleFile

Project article file details

Project article file details


/account/projects/{project_id}/articles/{article_id}/files/{file_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles/{article_id}/files/{file_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            PrivateFile result = apiInstance.privateProjectArticleFile(projectId, articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long articleId = new Long(); // Long | Project Article unique identifier
final Long fileId = new Long(); // Long | File unique identifier

try {
    final result = await api_instance.privateProjectArticleFile(projectId, articleId, fileId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticleFile: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier
        Long fileId = 789; // Long | File unique identifier

        try {
            PrivateFile result = apiInstance.privateProjectArticleFile(projectId, articleId, fileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *articleId = 789; // Project Article unique identifier (default to null)
Long *fileId = 789; // File unique identifier (default to null)

// Project article file details
[apiInstance privateProjectArticleFileWith:projectId
    articleId:articleId
    fileId:fileId
              completionHandler: ^(PrivateFile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var articleId = 789; // {Long} Project Article unique identifier
var fileId = 789; // {Long} File unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectArticleFile(projectId, articleId, fileId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticleFileExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var articleId = 789;  // Long | Project Article unique identifier (default to null)
            var fileId = 789;  // Long | File unique identifier (default to null)

            try {
                // Project article file details
                PrivateFile result = apiInstance.privateProjectArticleFile(projectId, articleId, fileId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticleFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$articleId = 789; // Long | Project Article unique identifier
$fileId = 789; // Long | File unique identifier

try {
    $result = $api_instance->privateProjectArticleFile($projectId, $articleId, $fileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticleFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $articleId = 789; # Long | Project Article unique identifier
my $fileId = 789; # Long | File unique identifier

eval {
    my $result = $api_instance->privateProjectArticleFile(projectId => $projectId, articleId => $articleId, fileId => $fileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticleFile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
articleId = 789 # Long | Project Article unique identifier (default to null)
fileId = 789 # Long | File unique identifier (default to null)

try:
    # Project article file details
    api_response = api_instance.private_project_article_file(projectId, articleId, fileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticleFile: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let articleId = 789; // Long
    let fileId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticleFile(projectId, articleId, fileId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
article_id*
Long (int64)
Project Article unique identifier
Required
file_id*
Long (int64)
File unique identifier
Required

Responses


privateProjectArticleFiles

Project article list files

List article files


/account/projects/{project_id}/articles/{article_id}/files

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles/{article_id}/files"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            array[PrivateFile] result = apiInstance.privateProjectArticleFiles(projectId, articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleFiles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long articleId = new Long(); // Long | Project Article unique identifier

try {
    final result = await api_instance.privateProjectArticleFiles(projectId, articleId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticleFiles: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long articleId = 789; // Long | Project Article unique identifier

        try {
            array[PrivateFile] result = apiInstance.privateProjectArticleFiles(projectId, articleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticleFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *articleId = 789; // Project Article unique identifier (default to null)

// Project article list files
[apiInstance privateProjectArticleFilesWith:projectId
    articleId:articleId
              completionHandler: ^(array[PrivateFile] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var articleId = 789; // {Long} Project Article unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectArticleFiles(projectId, articleId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticleFilesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var articleId = 789;  // Long | Project Article unique identifier (default to null)

            try {
                // Project article list files
                array[PrivateFile] result = apiInstance.privateProjectArticleFiles(projectId, articleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticleFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$articleId = 789; // Long | Project Article unique identifier

try {
    $result = $api_instance->privateProjectArticleFiles($projectId, $articleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticleFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $articleId = 789; # Long | Project Article unique identifier

eval {
    my $result = $api_instance->privateProjectArticleFiles(projectId => $projectId, articleId => $articleId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticleFiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
articleId = 789 # Long | Project Article unique identifier (default to null)

try:
    # Project article list files
    api_response = api_instance.private_project_article_files(projectId, articleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticleFiles: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let articleId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticleFiles(projectId, articleId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
article_id*
Long (int64)
Project Article unique identifier
Required

Responses


privateProjectArticlesCreate

Create project article

Create a new Article and associate it with this project


/account/projects/{project_id}/articles

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles" \
 -d '{
  "categories_by_source_id" : [ "300204", "400207" ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "keywords" : [ "tag1", "tag2" ],
  "references" : [ "http://figshare.com", "http://api.figshare.com" ],
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "related_materials" : [ {
    "id" : 10432,
    "identifier" : "10.6084/m9.figshare.1407024",
    "identifier_type" : "DOI",
    "relation" : "IsSupplementTo",
    "title" : "Figshare for institutions brochure",
    "is_linkout" : false
  } ],
  "description" : "Test description of article",
  "handle" : "",
  "title" : "Test article title",
  "tags" : [ "tag1", "tag2" ],
  "defined_type" : "media",
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "license" : 1,
  "resource_doi" : "",
  "resource_title" : "",
  "timeline" : {
    "firstOnline" : "2015-12-31",
    "publisherAcceptance" : "2015-12-31",
    "publisherPublication" : "2015-12-31"
  },
  "categories" : [ 1, 10, 11 ],
  "authors" : [ {
    "name" : "John Doe"
  }, {
    "id" : 1000008
  } ],
  "doi" : ""
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ArticleProjectCreate article = ; // ArticleProjectCreate | 

        try {
            Location result = apiInstance.privateProjectArticlesCreate(projectId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticlesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final ArticleProjectCreate article = new ArticleProjectCreate(); // ArticleProjectCreate | 

try {
    final result = await api_instance.privateProjectArticlesCreate(projectId, article);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticlesCreate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ArticleProjectCreate article = ; // ArticleProjectCreate | 

        try {
            Location result = apiInstance.privateProjectArticlesCreate(projectId, article);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticlesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
ArticleProjectCreate *article = ; // 

// Create project article
[apiInstance privateProjectArticlesCreateWith:projectId
    article:article
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var article = ; // {ArticleProjectCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectArticlesCreate(projectId, article, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticlesCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var article = new ArticleProjectCreate(); // ArticleProjectCreate | 

            try {
                // Create project article
                Location result = apiInstance.privateProjectArticlesCreate(projectId, article);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticlesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$article = ; // ArticleProjectCreate | 

try {
    $result = $api_instance->privateProjectArticlesCreate($projectId, $article);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticlesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $article = WWW::OPenAPIClient::Object::ArticleProjectCreate->new(); # ArticleProjectCreate | 

eval {
    my $result = $api_instance->privateProjectArticlesCreate(projectId => $projectId, article => $article);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticlesCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
article =  # ArticleProjectCreate | 

try:
    # Create project article
    api_response = api_instance.private_project_articles_create(projectId, article)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticlesCreate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let article = ; // ArticleProjectCreate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticlesCreate(projectId, article, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Body parameters
Name Description
article *

Article description

Responses

Name Type Format Description
Location String url Location of article


privateProjectArticlesList

List project articles

List project articles


/account/projects/{project_id}/articles

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/articles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            array[Article] result = apiInstance.privateProjectArticlesList(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticlesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectArticlesList(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectArticlesList: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            array[Article] result = apiInstance.privateProjectArticlesList(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectArticlesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// List project articles
[apiInstance privateProjectArticlesListWith:projectId
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectArticlesList(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectArticlesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // List project articles
                array[Article] result = apiInstance.privateProjectArticlesList(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectArticlesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $result = $api_instance->privateProjectArticlesList($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectArticlesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    my $result = $api_instance->privateProjectArticlesList(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectArticlesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # List project articles
    api_response = api_instance.private_project_articles_list(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectArticlesList: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectArticlesList(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectCollaboratorDelete

Remove project collaborator

Remove project collaborator


/account/projects/{project_id}/collaborators/{user_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/collaborators/{user_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long userId = 789; // Long | User unique identifier

        try {
            apiInstance.privateProjectCollaboratorDelete(projectId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long userId = new Long(); // Long | User unique identifier

try {
    final result = await api_instance.privateProjectCollaboratorDelete(projectId, userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectCollaboratorDelete: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long userId = 789; // Long | User unique identifier

        try {
            apiInstance.privateProjectCollaboratorDelete(projectId, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *userId = 789; // User unique identifier (default to null)

// Remove project collaborator
[apiInstance privateProjectCollaboratorDeleteWith:projectId
    userId:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var userId = 789; // {Long} User unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectCollaboratorDelete(projectId, userId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectCollaboratorDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var userId = 789;  // Long | User unique identifier (default to null)

            try {
                // Remove project collaborator
                apiInstance.privateProjectCollaboratorDelete(projectId, userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectCollaboratorDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$userId = 789; // Long | User unique identifier

try {
    $api_instance->privateProjectCollaboratorDelete($projectId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectCollaboratorDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $userId = 789; # Long | User unique identifier

eval {
    $api_instance->privateProjectCollaboratorDelete(projectId => $projectId, userId => $userId);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectCollaboratorDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
userId = 789 # Long | User unique identifier (default to null)

try:
    # Remove project collaborator
    api_instance.private_project_collaborator_delete(projectId, userId)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectCollaboratorDelete: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let userId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectCollaboratorDelete(projectId, userId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
user_id*
Long (int64)
User unique identifier
Required

Responses


privateProjectCollaboratorsInvite

Invite project collaborators

Invite users to collaborate on project or view the project


/account/projects/{project_id}/collaborators

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/collaborators" \
 -d '{
  "role_name" : "viewer",
  "user_id" : 100008,
  "comment" : "hey",
  "email" : "user@domain.com"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectCollaboratorInvite collaborator = ; // ProjectCollaboratorInvite | 

        try {
            ResponseMessage result = apiInstance.privateProjectCollaboratorsInvite(projectId, collaborator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorsInvite");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final ProjectCollaboratorInvite collaborator = new ProjectCollaboratorInvite(); // ProjectCollaboratorInvite | 

try {
    final result = await api_instance.privateProjectCollaboratorsInvite(projectId, collaborator);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectCollaboratorsInvite: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectCollaboratorInvite collaborator = ; // ProjectCollaboratorInvite | 

        try {
            ResponseMessage result = apiInstance.privateProjectCollaboratorsInvite(projectId, collaborator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorsInvite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
ProjectCollaboratorInvite *collaborator = ; // 

// Invite project collaborators
[apiInstance privateProjectCollaboratorsInviteWith:projectId
    collaborator:collaborator
              completionHandler: ^(ResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var collaborator = ; // {ProjectCollaboratorInvite} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectCollaboratorsInvite(projectId, collaborator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectCollaboratorsInviteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var collaborator = new ProjectCollaboratorInvite(); // ProjectCollaboratorInvite | 

            try {
                // Invite project collaborators
                ResponseMessage result = apiInstance.privateProjectCollaboratorsInvite(projectId, collaborator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectCollaboratorsInvite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$collaborator = ; // ProjectCollaboratorInvite | 

try {
    $result = $api_instance->privateProjectCollaboratorsInvite($projectId, $collaborator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectCollaboratorsInvite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $collaborator = WWW::OPenAPIClient::Object::ProjectCollaboratorInvite->new(); # ProjectCollaboratorInvite | 

eval {
    my $result = $api_instance->privateProjectCollaboratorsInvite(projectId => $projectId, collaborator => $collaborator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectCollaboratorsInvite: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
collaborator =  # ProjectCollaboratorInvite | 

try:
    # Invite project collaborators
    api_response = api_instance.private_project_collaborators_invite(projectId, collaborator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectCollaboratorsInvite: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let collaborator = ; // ProjectCollaboratorInvite

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectCollaboratorsInvite(projectId, collaborator, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Body parameters
Name Description
collaborator *

viewer or collaborator role. User user_id or email of user

Responses


privateProjectCollaboratorsList

List project collaborators

List Project collaborators and invited users


/account/projects/{project_id}/collaborators

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/collaborators"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            array[ProjectCollaborator] result = apiInstance.privateProjectCollaboratorsList(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectCollaboratorsList(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectCollaboratorsList: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            array[ProjectCollaborator] result = apiInstance.privateProjectCollaboratorsList(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCollaboratorsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// List project collaborators
[apiInstance privateProjectCollaboratorsListWith:projectId
              completionHandler: ^(array[ProjectCollaborator] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectCollaboratorsList(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectCollaboratorsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // List project collaborators
                array[ProjectCollaborator] result = apiInstance.privateProjectCollaboratorsList(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectCollaboratorsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $result = $api_instance->privateProjectCollaboratorsList($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectCollaboratorsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    my $result = $api_instance->privateProjectCollaboratorsList(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectCollaboratorsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # List project collaborators
    api_response = api_instance.private_project_collaborators_list(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectCollaboratorsList: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectCollaboratorsList(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectCreate

Create project

Create a new project


/account/projects

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects" \
 -d '{
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "group_id" : 0,
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "description" : "project description",
  "title" : "project title"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        ProjectCreate project = ; // ProjectCreate | 

        try {
            CreateProjectResponse result = apiInstance.privateProjectCreate(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ProjectCreate project = new ProjectCreate(); // ProjectCreate | 

try {
    final result = await api_instance.privateProjectCreate(project);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectCreate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        ProjectCreate project = ; // ProjectCreate | 

        try {
            CreateProjectResponse result = apiInstance.privateProjectCreate(project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
ProjectCreate *project = ; // 

// Create project
[apiInstance privateProjectCreateWith:project
              completionHandler: ^(CreateProjectResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var project = ; // {ProjectCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectCreate(project, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var project = new ProjectCreate(); // ProjectCreate | 

            try {
                // Create project
                CreateProjectResponse result = apiInstance.privateProjectCreate(project);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$project = ; // ProjectCreate | 

try {
    $result = $api_instance->privateProjectCreate($project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $project = WWW::OPenAPIClient::Object::ProjectCreate->new(); # ProjectCreate | 

eval {
    my $result = $api_instance->privateProjectCreate(project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
project =  # ProjectCreate | 

try:
    # Create project
    api_response = api_instance.private_project_create(project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectCreate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let project = ; // ProjectCreate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectCreate(project, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Body parameters
Name Description
project *

Project description

Responses


privateProjectDelete

Delete project

A project can be deleted only if: - it is not public - it does not have public articles. When an individual project is deleted, all the articles are moved to my data of each owner. When a group project is deleted, all the articles and files are deleted as well. Only project owner, group admin and above can delete a project.


/account/projects/{project_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            apiInstance.privateProjectDelete(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectDelete(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectDelete: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            apiInstance.privateProjectDelete(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// Delete project
[apiInstance privateProjectDeleteWith:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectDelete(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // Delete project
                apiInstance.privateProjectDelete(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $api_instance->privateProjectDelete($projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    $api_instance->privateProjectDelete(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # Delete project
    api_instance.private_project_delete(projectId)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectDelete: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectDelete(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectDetails

View project details

View a private project


/account/projects/{project_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            ProjectCompletePrivate result = apiInstance.privateProjectDetails(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectDetails(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectDetails: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            ProjectCompletePrivate result = apiInstance.privateProjectDetails(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// View project details
[apiInstance privateProjectDetailsWith:projectId
              completionHandler: ^(ProjectCompletePrivate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectDetails(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // View project details
                ProjectCompletePrivate result = apiInstance.privateProjectDetails(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $result = $api_instance->privateProjectDetails($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    my $result = $api_instance->privateProjectDetails(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # View project details
    api_response = api_instance.private_project_details(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectDetails: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectDetails(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectLeave

Private Project Leave

Please note: project's owner cannot leave the project.


/account/projects/{project_id}/leave

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/leave"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            apiInstance.privateProjectLeave(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectLeave");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectLeave(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectLeave: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            apiInstance.privateProjectLeave(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectLeave");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// Private Project Leave
[apiInstance privateProjectLeaveWith:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectLeave(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectLeaveExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // Private Project Leave
                apiInstance.privateProjectLeave(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectLeave: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $api_instance->privateProjectLeave($projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectLeave: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    $api_instance->privateProjectLeave(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectLeave: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # Private Project Leave
    api_instance.private_project_leave(projectId)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectLeave: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectLeave(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectNote

Project note details


/account/projects/{project_id}/notes/{note_id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/notes/{note_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier

        try {
            ProjectNotePrivate result = apiInstance.privateProjectNote(projectId, noteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNote");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long noteId = new Long(); // Long | Note unique identifier

try {
    final result = await api_instance.privateProjectNote(projectId, noteId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectNote: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier

        try {
            ProjectNotePrivate result = apiInstance.privateProjectNote(projectId, noteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNote");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *noteId = 789; // Note unique identifier (default to null)

// Project note details
[apiInstance privateProjectNoteWith:projectId
    noteId:noteId
              completionHandler: ^(ProjectNotePrivate output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var noteId = 789; // {Long} Note unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectNote(projectId, noteId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectNoteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var noteId = 789;  // Long | Note unique identifier (default to null)

            try {
                // Project note details
                ProjectNotePrivate result = apiInstance.privateProjectNote(projectId, noteId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectNote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$noteId = 789; // Long | Note unique identifier

try {
    $result = $api_instance->privateProjectNote($projectId, $noteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectNote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $noteId = 789; # Long | Note unique identifier

eval {
    my $result = $api_instance->privateProjectNote(projectId => $projectId, noteId => $noteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectNote: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
noteId = 789 # Long | Note unique identifier (default to null)

try:
    # Project note details
    api_response = api_instance.private_project_note(projectId, noteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectNote: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let noteId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectNote(projectId, noteId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
note_id*
Long (int64)
Note unique identifier
Required

Responses


privateProjectNoteDelete

Delete project note


/account/projects/{project_id}/notes/{note_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/notes/{note_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier

        try {
            apiInstance.privateProjectNoteDelete(projectId, noteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNoteDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long noteId = new Long(); // Long | Note unique identifier

try {
    final result = await api_instance.privateProjectNoteDelete(projectId, noteId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectNoteDelete: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier

        try {
            apiInstance.privateProjectNoteDelete(projectId, noteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNoteDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *noteId = 789; // Note unique identifier (default to null)

// Delete project note
[apiInstance privateProjectNoteDeleteWith:projectId
    noteId:noteId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var noteId = 789; // {Long} Note unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectNoteDelete(projectId, noteId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectNoteDeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var noteId = 789;  // Long | Note unique identifier (default to null)

            try {
                // Delete project note
                apiInstance.privateProjectNoteDelete(projectId, noteId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectNoteDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$noteId = 789; // Long | Note unique identifier

try {
    $api_instance->privateProjectNoteDelete($projectId, $noteId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectNoteDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $noteId = 789; # Long | Note unique identifier

eval {
    $api_instance->privateProjectNoteDelete(projectId => $projectId, noteId => $noteId);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectNoteDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
noteId = 789 # Long | Note unique identifier (default to null)

try:
    # Delete project note
    api_instance.private_project_note_delete(projectId, noteId)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectNoteDelete: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let noteId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectNoteDelete(projectId, noteId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
note_id*
Long (int64)
Note unique identifier
Required

Responses


privateProjectNoteUpdate

Update project note


/account/projects/{project_id}/notes/{note_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/notes/{note_id}" \
 -d '{
  "text" : "note to remember"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier
        ProjectNoteCreate note = ; // ProjectNoteCreate | 

        try {
            apiInstance.privateProjectNoteUpdate(projectId, noteId, note);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNoteUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long noteId = new Long(); // Long | Note unique identifier
final ProjectNoteCreate note = new ProjectNoteCreate(); // ProjectNoteCreate | 

try {
    final result = await api_instance.privateProjectNoteUpdate(projectId, noteId, note);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectNoteUpdate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long noteId = 789; // Long | Note unique identifier
        ProjectNoteCreate note = ; // ProjectNoteCreate | 

        try {
            apiInstance.privateProjectNoteUpdate(projectId, noteId, note);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNoteUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *noteId = 789; // Note unique identifier (default to null)
ProjectNoteCreate *note = ; // 

// Update project note
[apiInstance privateProjectNoteUpdateWith:projectId
    noteId:noteId
    note:note
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var noteId = 789; // {Long} Note unique identifier
var note = ; // {ProjectNoteCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectNoteUpdate(projectId, noteId, note, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectNoteUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var noteId = 789;  // Long | Note unique identifier (default to null)
            var note = new ProjectNoteCreate(); // ProjectNoteCreate | 

            try {
                // Update project note
                apiInstance.privateProjectNoteUpdate(projectId, noteId, note);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectNoteUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$noteId = 789; // Long | Note unique identifier
$note = ; // ProjectNoteCreate | 

try {
    $api_instance->privateProjectNoteUpdate($projectId, $noteId, $note);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectNoteUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $noteId = 789; # Long | Note unique identifier
my $note = WWW::OPenAPIClient::Object::ProjectNoteCreate->new(); # ProjectNoteCreate | 

eval {
    $api_instance->privateProjectNoteUpdate(projectId => $projectId, noteId => $noteId, note => $note);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectNoteUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
noteId = 789 # Long | Note unique identifier (default to null)
note =  # ProjectNoteCreate | 

try:
    # Update project note
    api_instance.private_project_note_update(projectId, noteId, note)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectNoteUpdate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let noteId = 789; // Long
    let note = ; // ProjectNoteCreate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectNoteUpdate(projectId, noteId, note, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
note_id*
Long (int64)
Note unique identifier
Required
Body parameters
Name Description
note *

Note message

Responses

Name Type Format Description
Location String url Location of article


privateProjectNotesCreate

Create project note

Create a new project note


/account/projects/{project_id}/notes

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/notes" \
 -d '{
  "text" : "note to remember"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectNoteCreate note = ; // ProjectNoteCreate | 

        try {
            Location result = apiInstance.privateProjectNotesCreate(projectId, note);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNotesCreate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final ProjectNoteCreate note = new ProjectNoteCreate(); // ProjectNoteCreate | 

try {
    final result = await api_instance.privateProjectNotesCreate(projectId, note);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectNotesCreate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectNoteCreate note = ; // ProjectNoteCreate | 

        try {
            Location result = apiInstance.privateProjectNotesCreate(projectId, note);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNotesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
ProjectNoteCreate *note = ; // 

// Create project note
[apiInstance privateProjectNotesCreateWith:projectId
    note:note
              completionHandler: ^(Location output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var note = ; // {ProjectNoteCreate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectNotesCreate(projectId, note, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectNotesCreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var note = new ProjectNoteCreate(); // ProjectNoteCreate | 

            try {
                // Create project note
                Location result = apiInstance.privateProjectNotesCreate(projectId, note);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectNotesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$note = ; // ProjectNoteCreate | 

try {
    $result = $api_instance->privateProjectNotesCreate($projectId, $note);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectNotesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $note = WWW::OPenAPIClient::Object::ProjectNoteCreate->new(); # ProjectNoteCreate | 

eval {
    my $result = $api_instance->privateProjectNotesCreate(projectId => $projectId, note => $note);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectNotesCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
note =  # ProjectNoteCreate | 

try:
    # Create project note
    api_response = api_instance.private_project_notes_create(projectId, note)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectNotesCreate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let note = ; // ProjectNoteCreate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectNotesCreate(projectId, note, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Body parameters
Name Description
note *

Note message

Responses

Name Type Format Description
Location String url Location of article


privateProjectNotesList

List project notes

List project notes


/account/projects/{project_id}/notes

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/notes?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[ProjectNote] result = apiInstance.privateProjectNotesList(projectId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNotesList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.privateProjectNotesList(projectId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectNotesList: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[ProjectNote] result = apiInstance.privateProjectNotesList(projectId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectNotesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// List project notes
[apiInstance privateProjectNotesListWith:projectId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[ProjectNote] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectNotesList(projectId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectNotesListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // List project notes
                array[ProjectNote] result = apiInstance.privateProjectNotesList(projectId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectNotesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->privateProjectNotesList($projectId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectNotesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->privateProjectNotesList(projectId => $projectId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectNotesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # List project notes
    api_response = api_instance.private_project_notes_list(projectId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectNotesList: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectNotesList(projectId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


privateProjectPartialUpdate

Partially update project

Partially update a project; only provided fields will be changed.


/account/projects/{project_id}

Usage and SDK Samples

curl -X PATCH \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}" \
 -d '{
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "description" : "project description",
  "title" : "project title"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectUpdate project = ; // ProjectUpdate | 

        try {
            apiInstance.privateProjectPartialUpdate(projectId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectPartialUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final ProjectUpdate project = new ProjectUpdate(); // ProjectUpdate | 

try {
    final result = await api_instance.privateProjectPartialUpdate(projectId, project);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectPartialUpdate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectUpdate project = ; // ProjectUpdate | 

        try {
            apiInstance.privateProjectPartialUpdate(projectId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectPartialUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
ProjectUpdate *project = ; //  (optional)

// Partially update project
[apiInstance privateProjectPartialUpdateWith:projectId
    project:project
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var opts = {
  'project':  // {ProjectUpdate} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectPartialUpdate(projectId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectPartialUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var project = new ProjectUpdate(); // ProjectUpdate |  (optional) 

            try {
                // Partially update project
                apiInstance.privateProjectPartialUpdate(projectId, project);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectPartialUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$project = ; // ProjectUpdate | 

try {
    $api_instance->privateProjectPartialUpdate($projectId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $project = WWW::OPenAPIClient::Object::ProjectUpdate->new(); # ProjectUpdate | 

eval {
    $api_instance->privateProjectPartialUpdate(projectId => $projectId, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectPartialUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
project =  # ProjectUpdate |  (optional)

try:
    # Partially update project
    api_instance.private_project_partial_update(projectId, project=project)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectPartialUpdate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let project = ; // ProjectUpdate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectPartialUpdate(projectId, project, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Body parameters
Name Description
project

Fields to update

Responses

Name Type Format Description
Location String link Location of project


privateProjectPublish

Private Project Publish

Publish a project. Possible after all items inside it are public


/account/projects/{project_id}/publish

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}/publish"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            ResponseMessage result = apiInstance.privateProjectPublish(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectPublish");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier

try {
    final result = await api_instance.privateProjectPublish(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectPublish: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier

        try {
            ResponseMessage result = apiInstance.privateProjectPublish(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectPublish");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)

// Private Project Publish
[apiInstance privateProjectPublishWith:projectId
              completionHandler: ^(ResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectPublish(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectPublishExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)

            try {
                // Private Project Publish
                ResponseMessage result = apiInstance.privateProjectPublish(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier

try {
    $result = $api_instance->privateProjectPublish($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier

eval {
    my $result = $api_instance->privateProjectPublish(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectPublish: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)

try:
    # Private Project Publish
    api_response = api_instance.private_project_publish(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectPublish: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectPublish(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required

Responses


privateProjectUpdate

Update project

Updating an project by passing body parameters.


/account/projects/{project_id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/{project_id}" \
 -d '{
  "funding_list" : [ {
    "id" : 0,
    "title" : "title"
  }, {
    "id" : 0,
    "title" : "title"
  } ],
  "custom_fields_list" : [ {
    "name" : "key",
    "value" : "value"
  }, {
    "name" : "key",
    "value" : "value"
  } ],
  "funding" : "",
  "custom_fields" : {
    "defined_key" : "value for it"
  },
  "description" : "project description",
  "title" : "project title"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectUpdate project = ; // ProjectUpdate | 

        try {
            apiInstance.privateProjectUpdate(projectId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project unique identifier
final ProjectUpdate project = new ProjectUpdate(); // ProjectUpdate | 

try {
    final result = await api_instance.privateProjectUpdate(projectId, project);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectUpdate: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project unique identifier
        ProjectUpdate project = ; // ProjectUpdate | 

        try {
            apiInstance.privateProjectUpdate(projectId, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project unique identifier (default to null)
ProjectUpdate *project = ; // 

// Update project
[apiInstance privateProjectUpdateWith:projectId
    project:project
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project unique identifier
var project = ; // {ProjectUpdate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.privateProjectUpdate(projectId, project, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectUpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project unique identifier (default to null)
            var project = new ProjectUpdate(); // ProjectUpdate | 

            try {
                // Update project
                apiInstance.privateProjectUpdate(projectId, project);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project unique identifier
$project = ; // ProjectUpdate | 

try {
    $api_instance->privateProjectUpdate($projectId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project unique identifier
my $project = WWW::OPenAPIClient::Object::ProjectUpdate->new(); # ProjectUpdate | 

eval {
    $api_instance->privateProjectUpdate(projectId => $projectId, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project unique identifier (default to null)
project =  # ProjectUpdate | 

try:
    # Update project
    api_instance.private_project_update(projectId, project)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectUpdate: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let project = ; // ProjectUpdate

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectUpdate(projectId, project, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project unique identifier
Required
Body parameters
Name Description
project *

Project description

Responses

Name Type Format Description
Location String link Location of project


privateProjectsList

Private Projects

List private projects


/account/projects

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/account/projects?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example&storage=storage_example&roles=roles_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order.
        String orderDirection = orderDirection_example; // String | 
        String storage = storage_example; // String | only return collections from this institution
        String roles = roles_example; // String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

        try {
            array[ProjectPrivate] result = apiInstance.privateProjectsList(page, pageSize, limit, offset, order, orderDirection, storage, roles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order.
final String orderDirection = new String(); // String | 
final String storage = new String(); // String | only return collections from this institution
final String roles = new String(); // String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

try {
    final result = await api_instance.privateProjectsList(page, pageSize, limit, offset, order, orderDirection, storage, roles);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectsList: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order.
        String orderDirection = orderDirection_example; // String | 
        String storage = storage_example; // String | only return collections from this institution
        String roles = roles_example; // String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

        try {
            array[ProjectPrivate] result = apiInstance.privateProjectsList(page, pageSize, limit, offset, order, orderDirection, storage, roles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)
String *storage = storage_example; // only return collections from this institution (optional) (default to null)
String *roles = roles_example; // Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator". (optional) (default to null)

// Private Projects
[apiInstance privateProjectsListWith:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
    storage:storage
    roles:roles
              completionHandler: ^(array[ProjectPrivate] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');
var defaultClient = FigshareApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order.
  'orderDirection': orderDirection_example, // {String} 
  'storage': storage_example, // {String} only return collections from this institution
  'roles': roles_example // {String} Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectsListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: OAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)
            var storage = storage_example;  // String | only return collections from this institution (optional)  (default to null)
            var roles = roles_example;  // String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator". (optional)  (default to null)

            try {
                // Private Projects
                array[ProjectPrivate] result = apiInstance.privateProjectsList(page, pageSize, limit, offset, order, orderDirection, storage, roles);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order.
$orderDirection = orderDirection_example; // String | 
$storage = storage_example; // String | only return collections from this institution
$roles = roles_example; // String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

try {
    $result = $api_instance->privateProjectsList($page, $pageSize, $limit, $offset, $order, $orderDirection, $storage, $roles);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Configure OAuth2 access token for authorization: OAuth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order.
my $orderDirection = orderDirection_example; # String | 
my $storage = storage_example; # String | only return collections from this institution
my $roles = roles_example; # String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

eval {
    my $result = $api_instance->privateProjectsList(page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection, storage => $storage, roles => $roles);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)
storage = storage_example # String | only return collections from this institution (optional) (default to null)
roles = roles_example # String | Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator". (optional) (default to null)

try:
    # Private Projects
    api_response = api_instance.private_projects_list(page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection, storage=storage, roles=roles)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectsList: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String
    let storage = storage_example; // String
    let roles = roles_example; // String

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectsList(page, pageSize, limit, offset, order, orderDirection, storage, roles, &context).wait();

    println!("{:?}", result);
}

Scopes

all Grants all access

Parameters

Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order.
order_direction
String
storage
String
only return collections from this institution
roles
String
Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".

Responses


privateProjectsSearch

Private Projects search

Search inside the private projects


/account/projects/search

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/account/projects/search" \
 -d '{
  "order" : "published_date"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        ProjectsSearch search = ; // ProjectsSearch | 

        try {
            array[ProjectPrivate] result = apiInstance.privateProjectsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ProjectsSearch search = new ProjectsSearch(); // ProjectsSearch | 

try {
    final result = await api_instance.privateProjectsSearch(search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->privateProjectsSearch: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        ProjectsSearch search = ; // ProjectsSearch | 

        try {
            array[ProjectPrivate] result = apiInstance.privateProjectsSearch(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#privateProjectsSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
ProjectsSearch *search = ; //  (optional)

// Private Projects search
[apiInstance privateProjectsSearchWith:search
              completionHandler: ^(array[ProjectPrivate] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var opts = {
  'search':  // {ProjectsSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.privateProjectsSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class privateProjectsSearchExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var search = new ProjectsSearch(); // ProjectsSearch |  (optional) 

            try {
                // Private Projects search
                array[ProjectPrivate] result = apiInstance.privateProjectsSearch(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.privateProjectsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$search = ; // ProjectsSearch | 

try {
    $result = $api_instance->privateProjectsSearch($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->privateProjectsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $search = WWW::OPenAPIClient::Object::ProjectsSearch->new(); # ProjectsSearch | 

eval {
    my $result = $api_instance->privateProjectsSearch(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->privateProjectsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
search =  # ProjectsSearch |  (optional)

try:
    # Private Projects search
    api_response = api_instance.private_projects_search(search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->privateProjectsSearch: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let search = ; // ProjectsSearch

    let mut context = ProjectsApi::Context::default();
    let result = client.privateProjectsSearch(search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
search

Search Parameters

Responses


projectArticles

Public Project Articles

List articles in project


/projects/{project_id}/articles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/projects/{project_id}/articles?page=789&page_size=789&limit=789&offset=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.projectArticles(projectId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectArticles");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project Unique identifier
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    final result = await api_instance.projectArticles(projectId, page, pageSize, limit, offset);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->projectArticles: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project Unique identifier
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

        try {
            array[Article] result = apiInstance.projectArticles(projectId, page, pageSize, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectArticles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project Unique identifier (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

// Public Project Articles
[apiInstance projectArticlesWith:projectId
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
              completionHandler: ^(array[Article] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project Unique identifier
var opts = {
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789 // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.projectArticles(projectId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class projectArticlesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project Unique identifier (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)

            try {
                // Public Project Articles
                array[Article] result = apiInstance.projectArticles(projectId, page, pageSize, limit, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.projectArticles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project Unique identifier
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit

try {
    $result = $api_instance->projectArticles($projectId, $page, $pageSize, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectArticles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project Unique identifier
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit

eval {
    my $result = $api_instance->projectArticles(projectId => $projectId, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->projectArticles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project Unique identifier (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)

try:
    # Public Project Articles
    api_response = api_instance.project_articles(projectId, page=page, pageSize=pageSize, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->projectArticles: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.projectArticles(projectId, page, pageSize, limit, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project Unique identifier
Required
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit

Responses


projectDetails

Public Project

View a project


/projects/{project_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/projects/{project_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project Unique identifier

        try {
            ProjectComplete result = apiInstance.projectDetails(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectDetails");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long projectId = new Long(); // Long | Project Unique identifier

try {
    final result = await api_instance.projectDetails(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->projectDetails: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Long projectId = 789; // Long | Project Unique identifier

        try {
            ProjectComplete result = apiInstance.projectDetails(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectDetails");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
Long *projectId = 789; // Project Unique identifier (default to null)

// Public Project
[apiInstance projectDetailsWith:projectId
              completionHandler: ^(ProjectComplete output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var projectId = 789; // {Long} Project Unique identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.projectDetails(projectId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class projectDetailsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = 789;  // Long | Project Unique identifier (default to null)

            try {
                // Public Project
                ProjectComplete result = apiInstance.projectDetails(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.projectDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 789; // Long | Project Unique identifier

try {
    $result = $api_instance->projectDetails($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 789; # Long | Project Unique identifier

eval {
    my $result = $api_instance->projectDetails(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->projectDetails: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 789 # Long | Project Unique identifier (default to null)

try:
    # Public Project
    api_response = api_instance.project_details(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->projectDetails: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.projectDetails(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
project_id*
Long (int64)
Project Unique identifier
Required

Responses


projectsList

Public Projects

Returns a list of public projects


/projects

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://api.figsh.com/v2/projects?page=789&page_size=789&limit=789&offset=789&order=order_example&order_direction=orderDirection_example&institution=789&published_since=publishedSince_example&group=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return collections from this institution
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
        Long group = 789; // Long | only return collections from this group

        try {
            array[Project] result = apiInstance.projectsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectsList");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final Long page = new Long(); // Long | Page number. Used for pagination with page_size
final Long pageSize = new Long(); // Long | The number of results included on a page. Used for pagination with page
final Long limit = new Long(); // Long | Number of results included on a page. Used for pagination with query
final Long offset = new Long(); // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
final String order = new String(); // String | The field by which to order. Default varies by endpoint/resource.
final String orderDirection = new String(); // String | 
final Long institution = new Long(); // Long | only return collections from this institution
final String publishedSince = new String(); // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
final Long group = new Long(); // Long | only return collections from this group

try {
    final result = await api_instance.projectsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, group);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->projectsList: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        Long page = 789; // Long | Page number. Used for pagination with page_size
        Long pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
        Long limit = 789; // Long | Number of results included on a page. Used for pagination with query
        Long offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
        String order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
        String orderDirection = orderDirection_example; // String | 
        Long institution = 789; // Long | only return collections from this institution
        String publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
        Long group = 789; // Long | only return collections from this group

        try {
            array[Project] result = apiInstance.projectsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectsList");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
Long *page = 789; // Page number. Used for pagination with page_size (optional) (default to null)
Long *pageSize = 789; // The number of results included on a page. Used for pagination with page (optional) (default to 10)
Long *limit = 789; // Number of results included on a page. Used for pagination with query (optional) (default to null)
Long *offset = 789; // Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
String *order = order_example; // The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
String *orderDirection = orderDirection_example; //  (optional) (default to desc)
Long *institution = 789; // only return collections from this institution (optional) (default to null)
String *publishedSince = publishedSince_example; // Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
Long *group = 789; // only return collections from this group (optional) (default to null)

// Public Projects
[apiInstance projectsListWith:xCursor
    page:page
    pageSize:pageSize
    limit:limit
    offset:offset
    order:order
    orderDirection:orderDirection
    institution:institution
    publishedSince:publishedSince
    group:group
              completionHandler: ^(array[Project] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'page': 789, // {Long} Page number. Used for pagination with page_size
  'pageSize': 789, // {Long} The number of results included on a page. Used for pagination with page
  'limit': 789, // {Long} Number of results included on a page. Used for pagination with query
  'offset': 789, // {Long} Where to start the listing (the offset of the first result). Used for pagination with limit
  'order': order_example, // {String} The field by which to order. Default varies by endpoint/resource.
  'orderDirection': orderDirection_example, // {String} 
  'institution': 789, // {Long} only return collections from this institution
  'publishedSince': publishedSince_example, // {String} Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
  'group': 789 // {Long} only return collections from this group
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.projectsList(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class projectsListExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var page = 789;  // Long | Page number. Used for pagination with page_size (optional)  (default to null)
            var pageSize = 789;  // Long | The number of results included on a page. Used for pagination with page (optional)  (default to 10)
            var limit = 789;  // Long | Number of results included on a page. Used for pagination with query (optional)  (default to null)
            var offset = 789;  // Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional)  (default to null)
            var order = order_example;  // String | The field by which to order. Default varies by endpoint/resource. (optional)  (default to published_date)
            var orderDirection = orderDirection_example;  // String |  (optional)  (default to desc)
            var institution = 789;  // Long | only return collections from this institution (optional)  (default to null)
            var publishedSince = publishedSince_example;  // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD (optional)  (default to null)
            var group = 789;  // Long | only return collections from this group (optional)  (default to null)

            try {
                // Public Projects
                array[Project] result = apiInstance.projectsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, group);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.projectsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$page = 789; // Long | Page number. Used for pagination with page_size
$pageSize = 789; // Long | The number of results included on a page. Used for pagination with page
$limit = 789; // Long | Number of results included on a page. Used for pagination with query
$offset = 789; // Long | Where to start the listing (the offset of the first result). Used for pagination with limit
$order = order_example; // String | The field by which to order. Default varies by endpoint/resource.
$orderDirection = orderDirection_example; // String | 
$institution = 789; // Long | only return collections from this institution
$publishedSince = publishedSince_example; // String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
$group = 789; // Long | only return collections from this group

try {
    $result = $api_instance->projectsList($xCursor, $page, $pageSize, $limit, $offset, $order, $orderDirection, $institution, $publishedSince, $group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $page = 789; # Long | Page number. Used for pagination with page_size
my $pageSize = 789; # Long | The number of results included on a page. Used for pagination with page
my $limit = 789; # Long | Number of results included on a page. Used for pagination with query
my $offset = 789; # Long | Where to start the listing (the offset of the first result). Used for pagination with limit
my $order = order_example; # String | The field by which to order. Default varies by endpoint/resource.
my $orderDirection = orderDirection_example; # String | 
my $institution = 789; # Long | only return collections from this institution
my $publishedSince = publishedSince_example; # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
my $group = 789; # Long | only return collections from this group

eval {
    my $result = $api_instance->projectsList(xCursor => $xCursor, page => $page, pageSize => $pageSize, limit => $limit, offset => $offset, order => $order, orderDirection => $orderDirection, institution => $institution, publishedSince => $publishedSince, group => $group);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->projectsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
page = 789 # Long | Page number. Used for pagination with page_size (optional) (default to null)
pageSize = 789 # Long | The number of results included on a page. Used for pagination with page (optional) (default to 10)
limit = 789 # Long | Number of results included on a page. Used for pagination with query (optional) (default to null)
offset = 789 # Long | Where to start the listing (the offset of the first result). Used for pagination with limit (optional) (default to null)
order = order_example # String | The field by which to order. Default varies by endpoint/resource. (optional) (default to published_date)
orderDirection = orderDirection_example # String |  (optional) (default to desc)
institution = 789 # Long | only return collections from this institution (optional) (default to null)
publishedSince = publishedSince_example # String | Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD (optional) (default to null)
group = 789 # Long | only return collections from this group (optional) (default to null)

try:
    # Public Projects
    api_response = api_instance.projects_list(xCursor=xCursor, page=page, pageSize=pageSize, limit=limit, offset=offset, order=order, orderDirection=orderDirection, institution=institution, publishedSince=publishedSince, group=group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->projectsList: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let page = 789; // Long
    let pageSize = 789; // Long
    let limit = 789; // Long
    let offset = 789; // Long
    let order = order_example; // String
    let orderDirection = orderDirection_example; // String
    let institution = 789; // Long
    let publishedSince = publishedSince_example; // String
    let group = 789; // Long

    let mut context = ProjectsApi::Context::default();
    let result = client.projectsList(xCursor, page, pageSize, limit, offset, order, orderDirection, institution, publishedSince, group, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Query parameters
Name Description
page
Long (int64)
Page number. Used for pagination with page_size
page_size
Long (int64)
The number of results included on a page. Used for pagination with page
limit
Long (int64)
Number of results included on a page. Used for pagination with query
offset
Long (int64)
Where to start the listing (the offset of the first result). Used for pagination with limit
order
String
The field by which to order. Default varies by endpoint/resource.
order_direction
String
institution
Long (int64)
only return collections from this institution
published_since
String
Filter by article publishing date. Will only return articles published after the date. date(ISO 8601) YYYY-MM-DD
group
Long (int64)
only return collections from this group

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.


projectsSearch

Public Projects Search

Returns a list of public articles


/projects/search

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.figsh.com/v2/projects/search" \
 -d '{
  "order" : "published_date"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        ProjectsSearch search = ; // ProjectsSearch | 

        try {
            array[Project] result = apiInstance.projectsSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectsSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xCursor = new UUID(); // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
final ProjectsSearch search = new ProjectsSearch(); // ProjectsSearch | 

try {
    final result = await api_instance.projectsSearch(xCursor, search);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->projectsSearch: $e\n');
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        UUID xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
        ProjectsSearch search = ; // ProjectsSearch | 

        try {
            array[Project] result = apiInstance.projectsSearch(xCursor, search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#projectsSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
UUID *xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
ProjectsSearch *search = ; //  (optional)

// Public Projects Search
[apiInstance projectsSearchWith:xCursor
    search:search
              completionHandler: ^(array[Project] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FigshareApi = require('figshare_api');

// Create an instance of the API class
var api = new FigshareApi.ProjectsApi()
var opts = {
  'xCursor': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
  'search':  // {ProjectsSearch} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.projectsSearch(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class projectsSearchExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional)  (default to null)
            var search = new ProjectsSearch(); // ProjectsSearch |  (optional) 

            try {
                // Public Projects Search
                array[Project] result = apiInstance.projectsSearch(xCursor, search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.projectsSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
$search = ; // ProjectsSearch | 

try {
    $result = $api_instance->projectsSearch($xCursor, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
my $search = WWW::OPenAPIClient::Object::ProjectsSearch->new(); # ProjectsSearch | 

eval {
    my $result = $api_instance->projectsSearch(xCursor => $xCursor, search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->projectsSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected. (optional) (default to null)
search =  # ProjectsSearch |  (optional)

try:
    # Public Projects Search
    api_response = api_instance.projects_search(xCursor=xCursor, search=search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->projectsSearch: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let xCursor = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let search = ; // ProjectsSearch

    let mut context = ProjectsApi::Context::default();
    let result = client.projectsSearch(xCursor, search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Cursor
UUID (uuid)
Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.
Body parameters
Name Description
search

Search Parameters

Responses

Name Type Format Description
X-Cursor String Unique hash used for bypassing the item retrieval limit of 9,000 entities.